kryten-cli 2.1.1__tar.gz

kryten_cli-2.1.1/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+
+All notable changes to kryten-cli will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.1.1] - 2025-12-09
+
+### Changed
+
+- Version bump to trigger PyPI release after project name reservation
+- All changes from v2.1.0 included
+
+## [2.1.0] - 2025-12-09
+
+### Changed
+
+- **Compatibility**: Lowered minimum Python version requirement from 3.11 to 3.10
+  - Updated dependency to kryten-py>=0.5.7 which supports Python 3.10
+  - Added Python 3.10 classifier
+  - Enhanced PyPI packaging with proper metadata and README
+
+### Added
+
+- **PyPI Publishing**: Added GitHub Actions workflow for automated PyPI releases
+- Enhanced setup.py with comprehensive metadata for PyPI
+- MANIFEST.in for proper file inclusion in distribution
+- MIT License file
+
+## [2.0.0] - 2025-12-08
+
+### Changed
+- **BREAKING**: Complete rewrite to use `kryten-py` library instead of direct NATS calls
+- Replaced all direct NATS publish operations with high-level KrytenClient methods
+- Updated configuration format to support `channels` array (maintains backward compatibility with legacy `cytube.channel` format)
+- Improved error handling and user feedback messages
+- Added URL parsing for media commands (YouTube, Vimeo, Dailymotion)
+- Updated dependency from `nats-py` to `kryten-py>=1.0.0`
+
+### Added
+- Media URL parsing for automatic type detection (YouTube, Vimeo, Dailymotion)
+- Support for new kryten-py configuration format
+- Better success messages showing channel and action details
+- `config.example.json` template file
+
+### Improved
+- Code is now cleaner and more maintainable
+- Type safety through kryten-py's typed API
+- Better separation of concerns
+- Consistent error handling
+
+### Removed
+- Direct NATS client usage
+- Manual subject construction
+- Manual message encoding/decoding
+
+## [1.0.0] - 2024
+
+### Added
+- Initial release with direct NATS implementation
+- Chat commands (say, pm)
+- Playlist commands (add, addnext, del, move, jump, clear, shuffle, settemp)
+- Playback commands (pause, play, seek)
+- Moderation commands (kick, ban, voteskip)

kryten_cli-2.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kryten Robot Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kryten_cli-2.1.1/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include requirements.txt
+include config.example.json
+include examples.sh
+include examples.ps1
+recursive-include docs *.md

kryten_cli-2.1.1/PKG-INFO

@@ -0,0 +1,313 @@
+Metadata-Version: 2.4
+Name: kryten-cli
+Version: 2.1.1
+Summary: Command-line client for CyTube via kryten-py library
+Home-page: https://github.com/grobertson/kryten-cli
+Author: Kryten Robot Team
+Author-email: Kryten Robot Team <kryten@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/grobertson/kryten-cli
+Project-URL: Bug Tracker, https://github.com/grobertson/kryten-cli/issues
+Project-URL: Source Code, https://github.com/grobertson/kryten-cli
+Project-URL: Documentation, https://github.com/grobertson/kryten-cli/blob/main/README.md
+Keywords: cytube,nats,cli,command-line,microservices,bot
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: kryten-py>=0.5.7
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Kryten CLI
+
+Command-line client for sending CyTube commands via the kryten-py library.
+
+## Overview
+
+This CLI provides a simple command-line interface to control CyTube channels through the Kryten bridge. It uses the high-level `kryten-py` library for all communication, making it a clean and maintainable reference implementation.
+
+## Installation
+
+Install the CLI tool:
+
+```bash
+pip install -e .
+```
+
+This will automatically install the `kryten-py` dependency.
+
+Or run directly:
+
+```bash
+python kryten_cli.py --help
+```
+
+## Configuration
+
+The CLI reads connection settings from `config.json` in the current directory. Create one with your NATS server and CyTube channel:
+
+```json
+{
+  "nats": {
+    "servers": ["nats://localhost:4222"]
+  },
+  "channels": [
+    {
+      "domain": "cytu.be",
+      "channel": "your-channel-name"
+    }
+  ]
+}
+```
+
+**Legacy Format Support:** The CLI also supports the older config format with `cytube.channel` for backward compatibility.
+
+You can also specify a different config file:
+
+```bash
+kryten --config /path/to/config.json say "Hello"
+```
+
+## Usage Examples
+
+### Chat Commands
+
+Send a chat message:
+```bash
+kryten say "Hello world"
+```
+
+Send a private message:
+```bash
+kryten pm UserName "Hi there!"
+```
+
+### Playlist Commands
+
+Add video to end of playlist:
+```bash
+kryten playlist add https://youtube.com/watch?v=xyz
+kryten playlist add yt:abc123
+```
+
+Add video to play next:
+```bash
+kryten playlist addnext https://youtube.com/watch?v=abc
+```
+
+Add as temporary (auto-deleted after playing):
+```bash
+kryten playlist add --temp https://youtube.com/watch?v=xyz
+```
+
+Delete video from playlist:
+```bash
+kryten playlist del video-uid-123
+```
+
+Move video in playlist:
+```bash
+kryten playlist move video-uid-5 after video-uid-3
+```
+
+Jump to specific video:
+```bash
+kryten playlist jump video-uid-7
+```
+
+Clear entire playlist:
+```bash
+kryten playlist clear
+```
+
+Shuffle playlist:
+```bash
+kryten playlist shuffle
+```
+
+Set video temporary status:
+```bash
+kryten playlist settemp video-uid-5 true
+kryten playlist settemp video-uid-5 false
+```
+
+### Playback Commands
+
+Pause current video:
+```bash
+kryten pause
+```
+
+Resume playback:
+```bash
+kryten play
+```
+
+Seek to timestamp (in seconds):
+```bash
+kryten seek 120.5
+```
+
+### Moderation Commands
+
+Kick user:
+```bash
+kryten kick UserName
+kryten kick UserName "Stop spamming"
+```
+
+Ban user:
+```bash
+kryten ban UserName
+kryten ban UserName "Banned for harassment"
+```
+
+Vote to skip current video:
+```bash
+kryten voteskip
+```
+
+## Command Reference
+
+| Command | Description |
+|---------|-------------|
+| `say <message>` | Send a chat message |
+| `pm <user> <message>` | Send a private message |
+| `playlist add <url>` | Add video to end of playlist |
+| `playlist addnext <url>` | Add video to play next |
+| `playlist del <uid>` | Delete video from playlist |
+| `playlist move <uid> after <uid>` | Move video in playlist |
+| `playlist jump <uid>` | Jump to specific video |
+| `playlist clear` | Clear entire playlist |
+| `playlist shuffle` | Shuffle playlist |
+| `playlist settemp <uid> <true\|false>` | Set temporary status |
+| `pause` | Pause playback |
+| `play` | Resume playback |
+| `seek <seconds>` | Seek to timestamp |
+| `kick <user> [reason]` | Kick user from channel |
+| `ban <user> [reason]` | Ban user from channel |
+| `voteskip` | Vote to skip current video |
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `--config <path>` | Path to config file (default: config.json) |
+| `--channel <name>` | Override channel from config |
+| `--help` | Show help message |
+
+## NATS Message Format
+
+All commands are published to NATS subjects following this pattern:
+
+```
+cytube.commands.{channel}.{action}
+```
+
+Message payload:
+```json
+{
+  "action": "chat",
+  "data": {
+    "message": "Hello world"
+  }
+}
+```
+
+This format is compatible with the Kryten bidirectional bridge's `CommandSubscriber`.
+
+## Requirements
+
+- Python 3.11+
+- nats-py >= 2.9.0
+- Kryten bidirectional bridge running with `commands.enabled = true`
+
+## Examples
+
+### Automated DJ
+
+Add a list of videos:
+```bash
+for url in $(cat playlist.txt); do
+  kryten playlist add "$url"
+  sleep 1
+done
+```
+
+### Bot Integration
+
+Use in scripts to respond to events:
+```bash
+#!/bin/bash
+# Greet new users
+kryten say "Welcome to the channel!"
+```
+
+### Remote Moderation
+
+Quick moderation commands:
+```bash
+kryten kick TrollUser "Please follow the rules"
+kryten ban SpamBot "Automated spam detected"
+```
+
+## Troubleshooting
+
+### Connection refused
+
+Make sure NATS server is running:
+```bash
+# Start NATS server
+nats-server
+```
+
+### Command not found
+
+Make sure the CLI is installed:
+```bash
+pip install -e .
+```
+
+Or use the module directly:
+```bash
+python kryten_cli.py say "Hello"
+```
+
+### Commands not executing
+
+1. Check that Kryten bridge is running
+2. Verify `commands.enabled = true` in Kryten's config
+3. Check NATS connection settings match between CLI and Kryten
+4. Verify channel name is correct
+
+## Version 2.0 - Using kryten-py Library
+
+**Version 2.0** is a complete rewrite that uses the `kryten-py` library instead of direct NATS calls. This provides:
+
+- **Cleaner code**: High-level API instead of low-level NATS
+- **Type safety**: Typed interfaces and better IDE support
+- **Better maintenance**: Shares code with other kryten projects
+- **New features**: Automatic URL parsing for media commands
+
+For migration information from v1.x, see [MIGRATION.md](MIGRATION.md).
+
+For complete details about the refactor, see [REFACTOR_SUMMARY.md](REFACTOR_SUMMARY.md).
+
+## Contributing
+
+This project serves as a reference implementation for using kryten-py. Contributions are welcome!
+
+## License
+
+See LICENSE file for details.

kryten_cli-2.1.1/README.md

@@ -0,0 +1,282 @@
+# Kryten CLI
+
+Command-line client for sending CyTube commands via the kryten-py library.
+
+## Overview
+
+This CLI provides a simple command-line interface to control CyTube channels through the Kryten bridge. It uses the high-level `kryten-py` library for all communication, making it a clean and maintainable reference implementation.
+
+## Installation
+
+Install the CLI tool:
+
+```bash
+pip install -e .
+```
+
+This will automatically install the `kryten-py` dependency.
+
+Or run directly:
+
+```bash
+python kryten_cli.py --help
+```
+
+## Configuration
+
+The CLI reads connection settings from `config.json` in the current directory. Create one with your NATS server and CyTube channel:
+
+```json
+{
+  "nats": {
+    "servers": ["nats://localhost:4222"]
+  },
+  "channels": [
+    {
+      "domain": "cytu.be",
+      "channel": "your-channel-name"
+    }
+  ]
+}
+```
+
+**Legacy Format Support:** The CLI also supports the older config format with `cytube.channel` for backward compatibility.
+
+You can also specify a different config file:
+
+```bash
+kryten --config /path/to/config.json say "Hello"
+```
+
+## Usage Examples
+
+### Chat Commands
+
+Send a chat message:
+```bash
+kryten say "Hello world"
+```
+
+Send a private message:
+```bash
+kryten pm UserName "Hi there!"
+```
+
+### Playlist Commands
+
+Add video to end of playlist:
+```bash
+kryten playlist add https://youtube.com/watch?v=xyz
+kryten playlist add yt:abc123
+```
+
+Add video to play next:
+```bash
+kryten playlist addnext https://youtube.com/watch?v=abc
+```
+
+Add as temporary (auto-deleted after playing):
+```bash
+kryten playlist add --temp https://youtube.com/watch?v=xyz
+```
+
+Delete video from playlist:
+```bash
+kryten playlist del video-uid-123
+```
+
+Move video in playlist:
+```bash
+kryten playlist move video-uid-5 after video-uid-3
+```
+
+Jump to specific video:
+```bash
+kryten playlist jump video-uid-7
+```
+
+Clear entire playlist:
+```bash
+kryten playlist clear
+```
+
+Shuffle playlist:
+```bash
+kryten playlist shuffle
+```
+
+Set video temporary status:
+```bash
+kryten playlist settemp video-uid-5 true
+kryten playlist settemp video-uid-5 false
+```
+
+### Playback Commands
+
+Pause current video:
+```bash
+kryten pause
+```
+
+Resume playback:
+```bash
+kryten play
+```
+
+Seek to timestamp (in seconds):
+```bash
+kryten seek 120.5
+```
+
+### Moderation Commands
+
+Kick user:
+```bash
+kryten kick UserName
+kryten kick UserName "Stop spamming"
+```
+
+Ban user:
+```bash
+kryten ban UserName
+kryten ban UserName "Banned for harassment"
+```
+
+Vote to skip current video:
+```bash
+kryten voteskip
+```
+
+## Command Reference
+
+| Command | Description |
+|---------|-------------|
+| `say <message>` | Send a chat message |
+| `pm <user> <message>` | Send a private message |
+| `playlist add <url>` | Add video to end of playlist |
+| `playlist addnext <url>` | Add video to play next |
+| `playlist del <uid>` | Delete video from playlist |
+| `playlist move <uid> after <uid>` | Move video in playlist |
+| `playlist jump <uid>` | Jump to specific video |
+| `playlist clear` | Clear entire playlist |
+| `playlist shuffle` | Shuffle playlist |
+| `playlist settemp <uid> <true\|false>` | Set temporary status |
+| `pause` | Pause playback |
+| `play` | Resume playback |
+| `seek <seconds>` | Seek to timestamp |
+| `kick <user> [reason]` | Kick user from channel |
+| `ban <user> [reason]` | Ban user from channel |
+| `voteskip` | Vote to skip current video |
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `--config <path>` | Path to config file (default: config.json) |
+| `--channel <name>` | Override channel from config |
+| `--help` | Show help message |
+
+## NATS Message Format
+
+All commands are published to NATS subjects following this pattern:
+
+```
+cytube.commands.{channel}.{action}
+```
+
+Message payload:
+```json
+{
+  "action": "chat",
+  "data": {
+    "message": "Hello world"
+  }
+}
+```
+
+This format is compatible with the Kryten bidirectional bridge's `CommandSubscriber`.
+
+## Requirements
+
+- Python 3.11+
+- nats-py >= 2.9.0
+- Kryten bidirectional bridge running with `commands.enabled = true`
+
+## Examples
+
+### Automated DJ
+
+Add a list of videos:
+```bash
+for url in $(cat playlist.txt); do
+  kryten playlist add "$url"
+  sleep 1
+done
+```
+
+### Bot Integration
+
+Use in scripts to respond to events:
+```bash
+#!/bin/bash
+# Greet new users
+kryten say "Welcome to the channel!"
+```
+
+### Remote Moderation
+
+Quick moderation commands:
+```bash
+kryten kick TrollUser "Please follow the rules"
+kryten ban SpamBot "Automated spam detected"
+```
+
+## Troubleshooting
+
+### Connection refused
+
+Make sure NATS server is running:
+```bash
+# Start NATS server
+nats-server
+```
+
+### Command not found
+
+Make sure the CLI is installed:
+```bash
+pip install -e .
+```
+
+Or use the module directly:
+```bash
+python kryten_cli.py say "Hello"
+```
+
+### Commands not executing
+
+1. Check that Kryten bridge is running
+2. Verify `commands.enabled = true` in Kryten's config
+3. Check NATS connection settings match between CLI and Kryten
+4. Verify channel name is correct
+
+## Version 2.0 - Using kryten-py Library
+
+**Version 2.0** is a complete rewrite that uses the `kryten-py` library instead of direct NATS calls. This provides:
+
+- **Cleaner code**: High-level API instead of low-level NATS
+- **Type safety**: Typed interfaces and better IDE support
+- **Better maintenance**: Shares code with other kryten projects
+- **New features**: Automatic URL parsing for media commands
+
+For migration information from v1.x, see [MIGRATION.md](MIGRATION.md).
+
+For complete details about the refactor, see [REFACTOR_SUMMARY.md](REFACTOR_SUMMARY.md).
+
+## Contributing
+
+This project serves as a reference implementation for using kryten-py. Contributions are welcome!
+
+## License
+
+See LICENSE file for details.

kryten_cli-2.1.1/config.example.json

@@ -0,0 +1,19 @@
+{
+  "nats": {
+    "servers": ["nats://localhost:4222"],
+    "user": null,
+    "password": null,
+    "token": null,
+    "connect_timeout": 10,
+    "reconnect_time_wait": 2,
+    "max_reconnect_attempts": 10,
+    "ping_interval": 120
+  },
+  "channels": [
+    {
+      "domain": "cytu.be",
+      "channel": "your-channel-name"
+    }
+  ],
+  "log_level": "INFO"
+}