KevinMidboe/delugeClient
1
0
Fork 0
mirror of https://github.com/KevinMidboe/delugeClient.git synced 2025-10-29 12:00:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Feat: Importable package (#10)

Browse Source 
* Append package directory to path

* Import all local files prefixed by package name

* Updated readme with -m flag for local development

* Decresed help text width in readme

* Bumped version to 0.3.4
This commit is contained in:
Kevin
2022-11-27 17:06:03 +01:00
committed by GitHub
parent 9bfa3c4c59
commit 8f2327c065
6 changed files with 41 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@@ -37,31 +37,38 @@ pip3 install delugeClient-kevin
``` ```
## <a name="usage"></a> Usage ## <a name="usage"></a> Usage
View delugeClient cli options with `delugeClient --help`: View delugeClient cli options with `delugeclient --help`:
``` ```
Usage: python -m delugeclient [OPTIONS] COMMAND [ARGS]... Usage: python -m delugeclient [OPTIONS] COMMAND [ARGS]...
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────╮ ╭─ Options ───────────────────────────────────────────────────────────────╮
│ --debug Set log level to debug │ │ --debug Set log level to debug │
│ --info Set log level to info │ │ --info Set log level to info │
│ --warning Set log level to warning │ │ --warning Set log level to warning │
│ --error Set log level to error │ │ --error Set log level to error │
│ --install-completion Install completion for the current shell. │ │ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │ │ --show-completion Show completion for the current shell │
│ --help Show this message and exit. │ │ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ╰─────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────╮ ╭─ Commands ──────────────────────────────────────────────────────────────╮
│ add Add magnet torrent │ │ add Add magnet torrent │
│ disk Get free disk space │ │ disk Get free disk space │
│ get Get torrent by id or hash │ │ get Get torrent by id or hash │
│ ls List all torrents │ │ ls List all torrents │
│ remove Remove torrent by id or hash │ │ remove Remove torrent by id or hash │
│ rm Remove torrent by name │ │ rm Remove torrent by name │
│ search Search for string segment in torrent name │ │ search Search for string segment in torrent name │
│ toggle Toggle torrent download state │ │ toggle Toggle torrent download state │
│ version Print package version │ │ version Print package version │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ╰─────────────────────────────────────────────────────────────────────────╯
```
### Running from source
Run from source for fun or during development using module flag:
```
python3 -m delugeClient --help
``` ```
## <a name="setup_virtualenv"></a> Setup Virtual Environment ## <a name="setup_virtualenv"></a> Setup Virtual Environment

8
delugeClient/__init__.py
View File

@@ -2,12 +2,14 @@
# -*- encoding: utf-8 -*- # -*- encoding: utf-8 -*-
from sys import path from sys import path
from os.path import dirname, join from os.path import dirname, join, abspath
path.append(dirname(__file__)) SCRIPT_DIR = dirname(abspath(__file__))
path.append(dirname(SCRIPT_DIR))
import logging import logging
from utils import BASE_DIR from delugeClient.utils import BASE_DIR
from delugeClient.deluge import Deluge
def addHandler(handler): def addHandler(handler):
handler.setFormatter(formatter) handler.setFormatter(formatter)

9
delugeClient/__main__.py
View File

@@ -1,5 +1,4 @@
#!/usr/bin/env python3.10 #!/usr/bin/env python3.10
import os import os
import sys import sys
import signal import signal
@@ -8,10 +7,10 @@ import logging
import typer import typer
from pprint import pprint from pprint import pprint
from deluge import Deluge from delugeClient.deluge import Deluge
from utils import ColorizeFilter, BASE_DIR, validHash, convertFilesize from delugeClient.utils import ColorizeFilter, BASE_DIR, validHash, convertFilesize
from __version__ import __version__ from delugeClient.__version__ import __version__
from __init__ import addHandler from delugeClient.__init__ import addHandler
ch = logging.StreamHandler() ch = logging.StreamHandler()
ch.addFilter(ColorizeFilter()) ch.addFilter(ColorizeFilter())

2
delugeClient/__version__.py
View File

@@ -1,4 +1,4 @@
__version__ = '0.3.3' __version__ = '0.3.4'
if __name__ == '__main__': if __name__ == '__main__':
print(__version__) print(__version__)

4
delugeClient/deluge.py
View File

@@ -9,9 +9,9 @@ import logging.config
from deluge_client import DelugeRPCClient, FailedToReconnectException from deluge_client import DelugeRPCClient, FailedToReconnectException
from sshtunnel import SSHTunnelForwarder, BaseSSHTunnelForwarderError from sshtunnel import SSHTunnelForwarder, BaseSSHTunnelForwarderError
from utils import getConfig, BASE_DIR
from torrent import Torrent from delugeClient.utils import getConfig, BASE_DIR
from delugeClient.torrent import Torrent
logger = logging.getLogger('deluge_cli') logger = logging.getLogger('deluge_cli')

2
delugeClient/torrent.py
View File

@@ -2,7 +2,7 @@ import json
import logging import logging
from distutils.util import strtobool from distutils.util import strtobool
from utils import convert from delugeClient.utils import convert
logger = logging.getLogger('deluge_cli') logger = logging.getLogger('deluge_cli')