codex-storage
/
deluge
mirror of https://github.com/codex-storage/deluge.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
deluge/README.md

72 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
# Deluge BitTorrent Client
[Install] Update and fix python optional requirements * Added required dependency setuptools to install_requires * Remove optional dependency ipaddress from install_requires * Created extras_require in setup.py. The optional dependencies should not be included in install_requires so that users can either install forked dependencies or remove problematic ones. Updated documentation to detail how to install these optional dependencies. * Fixed README badge Refs: * https://dev.deluge-torrent.org/ticket/3470 * https://dev.deluge-torrent.org/ticket/3282 * https://dev.deluge-torrent.org/ticket/3353
2019-06-21 09:56:10 +00:00
[![build-status]][github-ci] [![docs-status]][rtd-deluge]
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
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
[Lint] Fix spelling mistakes A quick fix of some of the mistakes caught by codespell. Updated readme with new IRC server Useful to add it as part of linting checks.
2021-09-21 20:40:13 +00:00
Console-UI. It uses [libtorrent][lt] at its core to handle the BitTorrent
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
protocol.
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
## Install
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
From [PyPi](https://pypi.org/project/deluge):
pip install deluge
[Install] Update and fix python optional requirements * Added required dependency setuptools to install_requires * Remove optional dependency ipaddress from install_requires * Created extras_require in setup.py. The optional dependencies should not be included in install_requires so that users can either install forked dependencies or remove problematic ones. Updated documentation to detail how to install these optional dependencies. * Fixed README badge Refs: * https://dev.deluge-torrent.org/ticket/3470 * https://dev.deluge-torrent.org/ticket/3282 * https://dev.deluge-torrent.org/ticket/3353
2019-06-21 09:56:10 +00:00
with all optional dependencies:
pip install deluge[all]
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
From source code:
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Install] Update and fix python optional requirements * Added required dependency setuptools to install_requires * Remove optional dependency ipaddress from install_requires * Created extras_require in setup.py. The optional dependencies should not be included in install_requires so that users can either install forked dependencies or remove problematic ones. Updated documentation to detail how to install these optional dependencies. * Fixed README badge Refs: * https://dev.deluge-torrent.org/ticket/3470 * https://dev.deluge-torrent.org/ticket/3282 * https://dev.deluge-torrent.org/ticket/3353
2019-06-21 09:56:10 +00:00
pip install .
with all optional dependencies:
pip install .[all]
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
See [DEPENDS](DEPENDS.md) and [Installing/Source] for dependency details.
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
## Usage
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
The various user-interfaces and Deluge daemon can be started with the following commands.
Use the `--help` option for further command options.
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
### Gtk UI
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
`deluge` or `deluge-gtk`
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
### Console UI
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
`deluge-console`
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
### Web UI
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
`deluge-web`
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
Open http://localhost:8112 with default password `deluge`.
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
### Daemon
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
`deluged`
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
See the [Thinclient guide] to connect to the daemon from another computer.
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
## Contact
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
- [Homepage](https://deluge-torrent.org)
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
- [User guide][user guide]
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
- [Forum](https://forum.deluge-torrent.org)
[Lint] Fix spelling mistakes A quick fix of some of the mistakes caught by codespell. Updated readme with new IRC server Useful to add it as part of linting checks.
2021-09-21 20:40:13 +00:00
- [IRC Libera.Chat #deluge](irc://irc.libera.chat/deluge)
[Docs] Add permanent discord invite link Default discord invites expire after 7 days so replace with non-expiring invite
2022-02-15 15:30:08 +00:00
- [Discord](https://discord.gg/nwaHSE6tqn)
Cleanup and use markdown for source text files Use markdown to aid readability. Update the README and use it for the long_description in setup.py Add detailed requirement information to the DEPENDS files.
2018-10-16 12:15:07 +00:00
[user guide]: https://dev.deluge-torrent.org/wiki/UserGuide
[thinclient guide]: https://dev.deluge-torrent.org/wiki/UserGuide/ThinClient
[installing/source]: https://dev.deluge-torrent.org/wiki/Installing/Source
[Install] Update and fix python optional requirements * Added required dependency setuptools to install_requires * Remove optional dependency ipaddress from install_requires * Created extras_require in setup.py. The optional dependencies should not be included in install_requires so that users can either install forked dependencies or remove problematic ones. Updated documentation to detail how to install these optional dependencies. * Fixed README badge Refs: * https://dev.deluge-torrent.org/ticket/3470 * https://dev.deluge-torrent.org/ticket/3282 * https://dev.deluge-torrent.org/ticket/3353
2019-06-21 09:56:10 +00:00
[build-status]: https://github.com/deluge-torrent/deluge/actions/workflows/ci.yml/badge.svg?branch=develop "CI"
[github-ci]: https://github.com/deluge-torrent/deluge/actions/workflows/ci.yml
[docs-status]: https://readthedocs.org/projects/deluge/badge/?version=latest
[rtd-deluge]: https://deluge.readthedocs.io/en/latest/?badge=latest "Documentation Status"
[Packaging] Cleanup README for Pypi - Set a minimal Python version 3.5 and remove universal wheels. - Tidy up the README - Add Project URL for issues and docs.
2019-05-21 14:48:43 +00:00
[lt]: https://libtorrent.org