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

101 lines
3.0 KiB
Markdown
Raw 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 dependencies
The following are required to install and run Deluge. They are separated into
sections to distinguish the precise requirements for each module.
All modules will require the [common](#common) section dependencies.
## Prerequisite
Upgrade codebase with pyupgrade (>=py3.6) Added pyupgrade utility with manual stage to pre-commit and run on all files. Ref: https://github.com/asottile/pyupgrade Closes: deluge-torrent/deluge#326
2021-12-28 20:20:57 +00:00
- [Python] _>= 3.6_
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
## Build
- [setuptools]
[Packaging] Cleanup dependencies - Tweaked the layout a bit with optional part of dependency description. - Updated descriptions to help understand dependency usage. - Made intltool and chardet packages optional. This will help with installation where these might be missing and are not crucial. - Remove gettext from dependency as is part of Python.
2018-10-17 11:56:36 +00:00
- [intltool] - Optional: Desktop file translation for \*nix.
[Build] Fix WebUI js minifying error Some users encoutered a bug where WebUI in browser show a white screen, which indicates a problem with loading javascript files. The problem was due to closure minifying failure leaving a zero-length deluge-all.js file which broke the usual fallback mechanism to debug files. * Fixed usage of ES6 const declaration breaking closure minifying. * Cleanup minified files upon errors so no zero length files left * Replaced broken and unmaintained slimit with rjsmin. * Fixed unable to set dev or debug query args due to request args requiring bytes.
2021-12-14 22:28:43 +00:00
- [closure-compiler] - Minify javascript (alternative is [rjsmin])
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
## Common
Raise Twisted minimum version to 17.1 The use of CertificateOptions with raiseMinimumTo requires this new minimum version so update requirements and documents.
2019-05-17 08:52:06 +00:00
- [Twisted] _>= 17.1_ - Use `TLS` extras for `service_identity` and `idna`.
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
- [OpenSSL] _>= 1.0.1_
- [pyOpenSSL]
[Dependency] Remove bundled rencode
2018-11-01 20:53:46 +00:00
- [rencode] _>= 1.0.2_ - Encoding library.
[Packaging] Cleanup dependencies - Tweaked the layout a bit with optional part of dependency description. - Updated descriptions to help understand dependency usage. - Made intltool and chardet packages optional. This will help with installation where these might be missing and are not crucial. - Remove gettext from dependency as is part of Python.
2018-10-17 11:56:36 +00:00
- [PyXDG] - Access freedesktop.org standards for \*nix.
- [xdg-utils] - Provides xdg-open for \*nix.
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
- [zope.interface]
[Packaging] Cleanup dependencies - Tweaked the layout a bit with optional part of dependency description. - Updated descriptions to help understand dependency usage. - Made intltool and chardet packages optional. This will help with installation where these might be missing and are not crucial. - Remove gettext from dependency as is part of Python.
2018-10-17 11:56:36 +00:00
- [chardet] - Optional: Encoding detection.
- [setproctitle] - Optional: Renaming processes.
[UI] Use Pillow for .ico icons Pillow added the code in Win32IconImagePlugin to v2.1 (in 2013) so we can remove it. Refactored the tracker_icons code to reflect this change.
2018-10-19 10:04:27 +00:00
- [Pillow] - Optional: Support for resizing tracker icons.
[Packaging] Cleanup dependencies - Tweaked the layout a bit with optional part of dependency description. - Updated descriptions to help understand dependency usage. - Made intltool and chardet packages optional. This will help with installation where these might be missing and are not crucial. - Remove gettext from dependency as is part of Python.
2018-10-17 11:56:36 +00:00
- [dbus-python] - Optional: Show item location in filemanager.
[Common] Add is_interface to validate network interfaces Libtorrent now supports interface names instead of just IP address so add new common functions to validate user input. * Added is_interface that will verify if a libtorrent interface of name or IP address. * Added is_interface_name to verify that the name supplied is a valid network interface name in the operating system. On Windows sock.if_nameindex() is only supported on 3.8+ and does not return a uuid (required by libtorrent) so use ifaddr package. Using git commit version for ifaddr due to adapter name decode bug in v0.1.7. On other OSes attempt to use stdlib and fallback to ifaddr if installed otherwiser return True. * Added tests for is_interface & is_interface_name * Updated UIs with change from address to interface * Updated is_ipv6 and is_ipv4 to used inet_pton; now supported on Windows. Ref: https://github.com/pydron/ifaddr/pull/32 Closes: https://github.com/deluge-torrent/deluge/pull/338
2020-02-13 05:13:44 +00:00
- [ifaddr] - Optional: Verify network interfaces.
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
[Docs] Replace recommonmark with MyST parser We used recommonmark so that we can use markdown in sphinx but it is buggy and now so switch to better supported MyST-parser. * Fixed incorrect heading warnings in markdown. * Added sphinx toctree to markdown using directive as required by MyST. * Upgraded Sphinx to 4.3 Ref: https://myst-parser.readthedocs.io
2021-12-12 15:29:41 +00:00
### Linux and BSD
[Common] Replace platform.linux_distribution function As of python 3.5, this function is marked as deprecated. So, [distro][1] is the one we will use (this package is listed at the example package in the python's [docs][2]). [1] https://pypi.org/project/distro/ [2] https://docs.python.org/3/library/platform.html#platform.dist
2019-05-08 20:24:45 +00:00
- [distro] - Optional: OS platform information.
[Docs] Replace recommonmark with MyST parser We used recommonmark so that we can use markdown in sphinx but it is buggy and now so switch to better supported MyST-parser. * Fixed incorrect heading warnings in markdown. * Added sphinx toctree to markdown using directive as required by MyST. * Upgraded Sphinx to 4.3 Ref: https://myst-parser.readthedocs.io
2021-12-12 15:29:41 +00:00
### Windows OS
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
- [pywin32]
- [certifi]
## Core (deluged daemon)
[Core] Stopped using libtorrent deprecated functions As part of the process of adding support to LT 2.0, we should stop using all deprecated function, as some (if not all) were removed. For this process, we should use the LT 1.2 upgrade (guide)[1]. The change includes: * stop using file entries directly * start using the torrent handle's set/unset flags * stop using url key in add_torrent_params (for magnet) * stop accessing resume_data from save_resume_data_alert * stop using deprecated session status keys in UI [1] https://libtorrent.org/upgrade_to_1.2-ref.html Closes: https://dev.deluge-torrent.org/ticket/3499 Closes: https://github.com/deluge-torrent/deluge/pull/342
2022-01-21 22:33:28 +00:00
- [libtorrent] _>= 1.2.0_
[Core] Add pygeoip dependency support Provide support for the pure-python pygeoip as compiled GeoIP is not always available. Ref: https://dev.deluge-torrent.org/ticket/3271
2019-06-17 16:21:44 +00:00
- [GeoIP] or [pygeoip] - Optional: IP address country lookup. (_Debian: `python-geoip`_)
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
## GTK UI
Update DEPENDS for GTK3
2018-10-21 17:33:06 +00:00
- [GTK+] >= 3.10
- [PyGObject]
- [Pycairo]
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
- [librsvg] _>= 2_
Update DEPENDS for GTK3
2018-10-21 17:33:06 +00:00
- [libappindicator3] w/GIR - Optional: Ubuntu system tray icon.
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
[Docs] Replace recommonmark with MyST parser We used recommonmark so that we can use markdown in sphinx but it is buggy and now so switch to better supported MyST-parser. * Fixed incorrect heading warnings in markdown. * Added sphinx toctree to markdown using directive as required by MyST. * Upgraded Sphinx to 4.3 Ref: https://myst-parser.readthedocs.io
2021-12-12 15:29:41 +00:00
### MacOS
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
- [GtkOSXApplication]
## Web UI
- [mako]
## Plugins
### Notifications
[Packaging] Cleanup dependencies - Tweaked the layout a bit with optional part of dependency description. - Updated descriptions to help understand dependency usage. - Made intltool and chardet packages optional. This will help with installation where these might be missing and are not crucial. - Remove gettext from dependency as is part of Python.
2018-10-17 11:56:36 +00:00
- [pygame] - Optional: Play sounds
Update DEPENDS for GTK3
2018-10-21 17:33:06 +00:00
- [libnotify] w/GIR - Optional: Desktop popups.
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
[python]: https://www.python.org/
[setuptools]: https://setuptools.readthedocs.io/en/latest/
[intltool]: https://freedesktop.org/wiki/Software/intltool/
[closure-compiler]: https://developers.google.com/closure/compiler/
[Build] Fix WebUI js minifying error Some users encoutered a bug where WebUI in browser show a white screen, which indicates a problem with loading javascript files. The problem was due to closure minifying failure leaving a zero-length deluge-all.js file which broke the usual fallback mechanism to debug files. * Fixed usage of ES6 const declaration breaking closure minifying. * Cleanup minified files upon errors so no zero length files left * Replaced broken and unmaintained slimit with rjsmin. * Fixed unable to set dev or debug query args due to request args requiring bytes.
2021-12-14 22:28:43 +00:00
[rjsmin]: https://pypi.org/project/rjsmin/
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
[openssl]: https://www.openssl.org/
[pyopenssl]: https://pyopenssl.org
[twisted]: https://twistedmatrix.com
[pillow]: https://pypi.org/project/Pillow/
[libtorrent]: https://libtorrent.org/
[zope.interface]: https://pypi.org/project/zope.interface/
[Common] Replace platform.linux_distribution function As of python 3.5, this function is marked as deprecated. So, [distro][1] is the one we will use (this package is listed at the example package in the python's [docs][2]). [1] https://pypi.org/project/distro/ [2] https://docs.python.org/3/library/platform.html#platform.dist
2019-05-08 20:24:45 +00:00
[distro]: https://github.com/nir0s/distro
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
[pywin32]: https://github.com/mhammond/pywin32
[certifi]: https://pypi.org/project/certifi/
[dbus-python]: https://pypi.org/project/dbus-python/
[setproctitle]: https://pypi.org/project/setproctitle/
[gtkosxapplication]: https://github.com/jralls/gtk-mac-integration
[chardet]: https://chardet.github.io/
[rencode]: https://github.com/aresch/rencode
[pyxdg]: https://www.freedesktop.org/wiki/Software/pyxdg/
[xdg-utils]: https://www.freedesktop.org/wiki/Software/xdg-utils/
Update DEPENDS for GTK3
2018-10-21 17:33:06 +00:00
[gtk+]: https://www.gtk.org/
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
[pycairo]: https://cairographics.org/pycairo/
[pygobject]: https://pygobject.readthedocs.io/en/latest/
[geoip]: https://pypi.org/project/GeoIP/
[mako]: https://www.makotemplates.org/
[pygame]: https://www.pygame.org/
Update DEPENDS for GTK3
2018-10-21 17:33:06 +00:00
[libnotify]: https://developer.gnome.org/libnotify/
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
[python-appindicator]: https://packages.ubuntu.com/xenial/python-appindicator
[librsvg]: https://wiki.gnome.org/action/show/Projects/LibRsvg
[Common] Add is_interface to validate network interfaces Libtorrent now supports interface names instead of just IP address so add new common functions to validate user input. * Added is_interface that will verify if a libtorrent interface of name or IP address. * Added is_interface_name to verify that the name supplied is a valid network interface name in the operating system. On Windows sock.if_nameindex() is only supported on 3.8+ and does not return a uuid (required by libtorrent) so use ifaddr package. Using git commit version for ifaddr due to adapter name decode bug in v0.1.7. On other OSes attempt to use stdlib and fallback to ifaddr if installed otherwiser return True. * Added tests for is_interface & is_interface_name * Updated UIs with change from address to interface * Updated is_ipv6 and is_ipv4 to used inet_pton; now supported on Windows. Ref: https://github.com/pydron/ifaddr/pull/32 Closes: https://github.com/deluge-torrent/deluge/pull/338
2020-02-13 05:13:44 +00:00
[ifaddr]: https://pypi.org/project/ifaddr/