mirror of https://github.com/codex-storage/deluge.git synced 2025-01-11 03:55:43 +00:00

Go to file

Calum Lind 82ecf8a416 [Docs] Reorganise and add sections from wiki

- Change the layout and contents of docs to be better organised and
  follow ideas from: https://www.divio.com/blog/documentation/
- Use markdown for non-technical documents to speed up writing.
- Added new sections and imported documents from Trac wiki.

Build fixes:

- Added a patch to fix recommonmark 0.4 and doc referencing:
    https://github.com/rtfd/recommonmark/issues/93
- Set docs build in tox to Py2.7 since there are problems with autodoc
  mocking multiple inheritance on Python 3 resulting in metaclass errors.
- Supressed warning about `modules.rst` not in the toctree by creating
  a static `modules.rst` with `:orphan:` file directive and add to git.
  Also skip creating this toc file with sphinx-apidoc in setup and tox.
- Simplified finding exported RPC and JSON API methods by adding an
  autodoc custom class directive. Removed unneeded __rpcapi.py.

2018-11-01 17:38:10 +00:00

deluge

[Docs] Reorganise and add sections from wiki

2018-11-01 17:38:10 +00:00

docs

[Docs] Reorganise and add sections from wiki

2018-11-01 17:38:10 +00:00

packaging

[Packaging] Update make_release script for Py3

2018-10-19 14:14:03 +01:00

.gitattributes

[WebUI] Update extjs to 3.4.1.1

2018-10-08 14:47:27 +01:00

.gitignore

[Docs] Reorganise and add sections from wiki

2018-11-01 17:38:10 +00:00

.pre-commit-config.yaml

Update pre-commit config

2018-10-08 14:49:36 +01: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

[GTKUI] Refactor gtk imports and code

2016-11-11 22:21:51 +00:00

.travis.yml

Cleanup Tox and CI configs

2018-10-10 18:50:41 +01:00

appveyor.yml

Cleanup Tox and CI configs

2018-10-10 18:50:41 +01:00

AUTHORS

Update author name as per request

2015-08-17 23:03:48 +01:00

CHANGELOG.md

Cleanup and use markdown for source text files

2018-10-16 14:59:00 +01:00

DEPENDS.md

[Packaging] Cleanup dependencies

2018-10-19 14:14:03 +01:00

gen_web_gettext.py

[Lint] Use Black to auto-format code

2018-10-03 15:21:53 +01:00

generate_pot.py

[GTK] Fixup translation strings

2018-10-21 13:51:30 +01:00

LICENSE

Update LICENSE in trunk too..

2009-04-06 21:17:26 +00:00

MANIFEST.in

Fix sdist missing test files

2018-10-16 14:59:00 +01:00

minify_web_js.py

Update javascript minifying script

2018-10-16 11:34:55 +01:00

msgfmt.py

[Lint] Use Black to auto-format code

2018-10-03 15:21:53 +01:00

pyproject.toml

[Tests] Remove slimit dependency

2018-10-08 12:19:03 +01:00

README.md

Cleanup and use markdown for source text files

2018-10-16 14:59:00 +01:00

requirements-dev.txt

[Lint] Exclude js and css from EOF fixer

2018-10-05 18:45:37 +01:00

requirements-docs.txt

[Docs] Add markdown support

2018-10-04 15:53:42 +01:00

requirements-tests.txt

[Tests] Update tox and CI configs

2018-10-05 13:23:45 +01:00

requirements.txt

Update tox and CI for Python 3

2018-10-10 17:57:02 +01:00

setup.cfg

[Docs] Reorganise and add sections from wiki

2018-11-01 17:38:10 +00:00

setup.py

[Docs] Reorganise and add sections from wiki

2018-11-01 17:38:10 +00:00

tox.ini

[Docs] Reorganise and add sections from wiki

2018-11-01 17:38:10 +00:00

version.py

[Lint] Use Black to auto-format code

2018-10-03 15:21:53 +01:00

README.md

Deluge BitTorrent Client

Deluge is a BitTorrent client that utilizes a daemon/client model. There are various user interfaces available for Deluge such as the GTK-UI, the Web-UI and a Console-UI. Deluge uses libtorrent in it's backend to handle the BitTorrent protocol.

Installation

Instruction for installing from source code. See DEPENDS for build and runtime dependencies. Further details on the wiki: Installing/Source.

python setup.py build
python setup.py install

Usage

There are various user-interfaces and a daemon for Deluge that can be used as follows:

Gtk

deluge or deluge-gtk
Console

deluge-console
Web

deluge-web

Go to http://localhost:8112 and use default password deluge.
Daemon

deluged

See Thinclient guide for connecting to the daemon from another machine.

Contact/Support

Languages

Python 75.6%

JavaScript 15.3%

CSS 8.3%

Shell 0.4%

NSIS 0.3%

Other 0.1%