Abstract • - Setup virtualenv • - Configure • - Install dependencies • + Install • Usage • - Running • + Setup Virtual Environment • + Configure • Contributing
@@ -28,6 +25,44 @@ ## Abstract Create a deluge python client for interfacing with deluge for common tasks like listing, adding, removing and setting download directory for torrents. +## Install +Install from source: +```bash +python3 setup.py install +``` + +Install from pip: +```bash +pip3 install delugeClient-kevin +``` + +## Usage +View delugeClient cli options with `delugeClient --help`: + +``` + Usage: python -m delugeclient [OPTIONS] COMMAND [ARGS]... + +╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ --debug Set log level to debug │ +│ --info Set log level to info │ +│ --warning Set log level to warning │ +│ --error Set log level to error │ +│ --install-completion Install completion for the current shell. │ +│ --show-completion Show completion for the current shell, to copy it or customize the installation. │ +│ --help Show this message and exit. │ +╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ add Add magnet torrent │ +│ disk Get free disk space │ +│ get Get torrent by id or hash │ +│ ls List all torrents │ +│ remove Remove torrent by id or hash │ +│ rm Remove torrent by name │ +│ search Search for string segment in torrent name │ +│ toggle Toggle torrent download state │ +│ version Print package version │ +╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +``` ## Setup Virtual Environment Virtual environment allows us to create a local environment for the requirements needed. Because pip does not download packages already downloaded to your system, we can use virtualenv to save our packages in the project folder. @@ -41,7 +76,7 @@ To install virtualenv, simply run: ``` -### Usage +### Virtualenv setup After you have downloaded this project go to it in your terminal by going to the folder you downloaded and typing the following: @@ -58,8 +93,6 @@ The to setup a virtual environment enter this: > If you get an error now it might be because you don't have python3.10, please make sure you have python version 3.10 if else you can download it from [here](https://www.python.org/downloads/) -First we navigate to the folder we downloaded. - Then we use the ```virtualenv``` command to create a ```env``` subdirectory in our project. This is where pip will download everything to and where we can add other specific python versions. Then we need to *activate* our virtual environment by doing: ``` @@ -96,51 +129,6 @@ Then you need to change the HOST and PORT to reflect the address for your deluge $ cat /home/USER/.config/deluge/auth ``` - -## Install Required Dependencies -Now that we have our virutalenv set up and activated we want to install all the necessary packages listed in `requirements.txt`. To install it's dependencies do the following: - -``` - $ pip install -r requirements.txt -``` - -Now we have our neccessary packages installed! - - -## Usage - -``` -Custom delugeRPC client -Usage: - deluge_cli add MAGNET [DIR] [--debug | --warning | --error] - deluge_cli get TORRENT - deluge_cli ls [--downloading | --seeding | --paused] - deluge_cli toggle TORRENT - deluge_cli rm TORRENT [--debug | --warning | --error] - deluge_cli (-h | --help) - deluge_cli --version - -Arguments: - MAGNET Magnet link to add - DIR Directory to save to - TORRENT A selected torrent - -Options: - -h --help Show this screen - --version Show version - --debug Print all debug log - --warning Print only logged warnings - --error Print error messages (Error/Warning) -``` - -### Running -To interface with deluged : - -``` - $ ./deluge_cli.py ls -``` - - ## Contributing - Fork it! - Create your feature branch: git checkout -b my-new-feature diff --git a/setup.py b/setup.py index 1a28613..04f7edc 100644 --- a/setup.py +++ b/setup.py @@ -32,6 +32,7 @@ setup( classifiers=[ 'Programming Language :: Python', 'Operating System :: OS Independent', + 'License :: OSI Approved :: MIT License', 'Programming Language :: Python :: 3.10', ], entry_points={