Deluge BitTorrent client - Git mirror, PRs only https://www.deluge-torrent.org
Go to file
Chase Sterling 4096cdfdfe
[Core] Document all exported core methods with type hints
Standardize docstrings in core.py to google standard.
Remove type hints in docstrings in favor of the ones in method signatures.

Use function signature type hints in autodoc generated docs.

Closes: https://github.com/deluge-torrent/deluge/pull/359
2022-02-05 17:23:50 +00:00
.github/workflows [CI] Fix checkout action missing fetch depth 2022-02-01 06:45:10 +00:00
deluge [Core] Document all exported core methods with type hints 2022-02-05 17:23:50 +00:00
docs [Core] Document all exported core methods with type hints 2022-02-05 17:23:50 +00:00
packaging [Common] Add is_interface to validate network interfaces 2022-01-30 16:13:27 +00:00
.gitattributes [Tests] Fix erroneous windows line endings in test state file 2022-01-26 18:44:47 +00:00
.gitignore [Core] Stop using removed disk.num_blocks_cache_hits stat 2021-10-03 14:19:17 +01:00
.pre-commit-config.yaml Upgrade codebase with pyupgrade (>=py3.6) 2021-12-29 21:51:07 +00:00
.prettierignore [Lint] Format files with Prettier 2018-10-03 18:16:09 +01:00
.prettierrc.yaml [Lint] Format files with Prettier 2018-10-03 18:16:09 +01:00
.pylintrc Remove all Python 2 support 2021-12-28 19:26:38 +00:00
.readthedocs.yml [Docs] Fix missing path in RTD config 2019-05-22 18:01:05 +01:00
AUTHORS [UI] Add magnet icons for copy and add actions 2021-09-21 20:38:08 +01:00
CHANGELOG.md Remove all Python 2 support 2021-12-28 19:26:38 +00:00
DEPENDS.md [Common] Add is_interface to validate network interfaces 2022-01-30 16:13:27 +00:00
LICENSE Update LICENSE in trunk too.. 2009-04-06 21:17:26 +00:00
MANIFEST.in [Packaging] Fix gtk3 glade path in MANIFEST 2021-11-23 20:07:33 +00:00
README.md [Docs] Add discord link to readme 2022-01-30 16:17:05 +00:00
gen_web_gettext.py Upgrade codebase with pyupgrade (>=py3.6) 2021-12-29 21:51:07 +00:00
generate_pot.py Upgrade codebase with pyupgrade (>=py3.6) 2021-12-29 21:51:07 +00:00
minify_web_js.py Upgrade codebase with pyupgrade (>=py3.6) 2021-12-29 21:51:07 +00:00
msgfmt.py Upgrade codebase with pyupgrade (>=py3.6) 2021-12-29 21:51:07 +00:00
pyproject.toml Remove all Python 2 support 2021-12-28 19:26:38 +00:00
requirements-dev.txt [Build] Fix WebUI js minifying error 2021-12-15 09:37:55 +00:00
requirements-tests.txt [Lint] Update pre-commit hook and isort versions 2021-01-24 20:40:20 +00:00
requirements.txt [Common] Add is_interface to validate network interfaces 2022-01-30 16:13:27 +00:00
setup.cfg [Lint] Update pre-commit hook and isort versions 2021-01-24 20:40:20 +00:00
setup.py [Common] Add is_interface to validate network interfaces 2022-01-30 16:13:27 +00:00
tox.ini Remove all Python 2 support 2021-12-28 19:26:38 +00:00
version.py Upgrade codebase with pyupgrade (>=py3.6) 2021-12-29 21:51:07 +00:00

README.md

Deluge BitTorrent Client

build-status docs-status

Deluge is a BitTorrent client that utilizes a daemon/client model. It has various user interfaces available such as the GTK-UI, Web-UI and Console-UI. It uses libtorrent at its core to handle the BitTorrent protocol.

Install

From PyPi:

pip install deluge

with all optional dependencies:

pip install deluge[all]

From source code:

pip install .

with all optional dependencies:

pip install .[all]

See DEPENDS and Installing/Source for dependency details.

Usage

The various user-interfaces and Deluge daemon can be started with the following commands.

Use the --help option for further command options.

Gtk UI

deluge or deluge-gtk

Console UI

deluge-console

Web UI

deluge-web

Open http://localhost:8112 with default password deluge.

Daemon

deluged

See the Thinclient guide to connect to the daemon from another computer.

Contact