[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.
This commit is contained in:
parent
65f6ede8b2
commit
a8fac1381b
|
@ -46,10 +46,12 @@ addons:
|
|||
# Install dependencies
|
||||
install:
|
||||
- pip install tox tox-venv
|
||||
# GTKUI tests
|
||||
- "if [ $TOX_ENV == 'gtkui' ]; then
|
||||
sudo apt install python-gi python-gi-cairo python3-gi python3-gi-cairo \
|
||||
gir1.2-gtk-3.0;
|
||||
fi"
|
||||
# Security tests
|
||||
- "if [ $TOX_ENV == 'security' ]; then
|
||||
testssl_url=https://github.com/drwetter/testssl.sh/archive/v2.9.5-5.tar.gz;
|
||||
wget -O- $testssl_url | tar xz
|
||||
|
@ -58,6 +60,7 @@ install:
|
|||
|
||||
before_script:
|
||||
- export PYTHONPATH=$PYTHONPATH:$PWD
|
||||
# Verify libtorrent installed and version
|
||||
- python -c "import libtorrent as lt; print(lt.__version__)"
|
||||
# Start xvfb for the GTKUI tests
|
||||
- "if [ $TOX_ENV == 'gtkui' ]; then
|
||||
|
@ -65,6 +68,7 @@ before_script:
|
|||
--make-pidfile --pidfile /tmp/custom_xvfb_99.pid \
|
||||
--exec /usr/bin/Xvfb -- :99 -ac -screen 0 1280x1024x16;
|
||||
fi"
|
||||
# Create missing version file
|
||||
- echo "2.0.0.dev0" > RELEASE-VERSION
|
||||
|
||||
script:
|
||||
|
|
50
README.md
50
README.md
|
@ -2,49 +2,54 @@
|
|||
|
||||
[![build-status]][travis-deluge] [![docs-status]][rtd-deluge]
|
||||
|
||||
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.
|
||||
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
|
||||
a Console-UI. It uses [libtorrent][lt] at it's core to handle the BitTorrent
|
||||
protocol.
|
||||
|
||||
## Installation
|
||||
## Install
|
||||
|
||||
Instruction for installing from source code. See [DEPENDS](DEPENDS.md) for
|
||||
build and runtime dependencies. Further details on the wiki:
|
||||
[Installing/Source].
|
||||
From [PyPi](https://pypi.org/project/deluge):
|
||||
|
||||
pip install deluge
|
||||
|
||||
From source code:
|
||||
|
||||
python setup.py build
|
||||
python setup.py install
|
||||
|
||||
See [DEPENDS](DEPENDS.md) and [Installing/Source] for dependency details.
|
||||
|
||||
## Usage
|
||||
|
||||
There are various user-interfaces and a daemon for Deluge that can be used as
|
||||
follows:
|
||||
The various user-interfaces and Deluge daemon can be started with the following commands.
|
||||
|
||||
- **Gtk**
|
||||
Use the `--help` option for further command options.
|
||||
|
||||
`deluge` or `deluge-gtk`
|
||||
### Gtk UI
|
||||
|
||||
- **Console**
|
||||
`deluge` or `deluge-gtk`
|
||||
|
||||
`deluge-console`
|
||||
### Console UI
|
||||
|
||||
- **Web**
|
||||
`deluge-console`
|
||||
|
||||
`deluge-web`
|
||||
### Web UI
|
||||
|
||||
Go to http://localhost:8112 and use default password `deluge`.
|
||||
`deluge-web`
|
||||
|
||||
- **Daemon**
|
||||
Open http://localhost:8112 with default password `deluge`.
|
||||
|
||||
`deluged`
|
||||
### Daemon
|
||||
|
||||
See [Thinclient guide] for connecting to the daemon from another machine.
|
||||
`deluged`
|
||||
|
||||
## Contact/Support
|
||||
See the [Thinclient guide] to connect to the daemon from another computer.
|
||||
|
||||
## Contact
|
||||
|
||||
- [Homepage](https://deluge-torrent.org)
|
||||
- [Support docs][user guide]
|
||||
- [User guide][user guide]
|
||||
- [Forum](https://forum.deluge-torrent.org)
|
||||
- [IRC Freenode #deluge](irc://irc.freenode.net/deluge)
|
||||
|
||||
|
@ -55,3 +60,4 @@ follows:
|
|||
[travis-deluge]: https://travis-ci.org/deluge-torrent/deluge
|
||||
[docs-status]: https://readthedocs.org/projects/deluge/badge/?version=develop
|
||||
[rtd-deluge]: https://deluge.readthedocs.io/en/develop/?badge=develop "Documentation Status"
|
||||
[lt]: https://libtorrent.org
|
||||
|
|
|
@ -1,6 +1,3 @@
|
|||
[bdist_wheel]
|
||||
universal = 1
|
||||
|
||||
[build_docs]
|
||||
source-dir = docs/source
|
||||
build-dir = docs/build
|
||||
|
|
8
setup.py
8
setup.py
|
@ -567,6 +567,13 @@ setup(
|
|||
long_description=open('README.md').read(),
|
||||
long_description_content_type='text/markdown',
|
||||
url='https://deluge-torrent.org',
|
||||
project_urls={
|
||||
'GitHub (mirror)': 'https://github.com/deluge-torrent/deluge',
|
||||
'Sourcecode': 'http://git.deluge-torrent.org/deluge',
|
||||
'Issues': 'https://dev.deluge-torrent.org/report/1',
|
||||
'Discussion': 'https://forum.deluge-torrent.org',
|
||||
'Documentation': 'https://deluge.readthedocs.io',
|
||||
},
|
||||
classifiers=[
|
||||
'Development Status :: 4 - Beta',
|
||||
'Environment :: Console',
|
||||
|
@ -584,6 +591,7 @@ setup(
|
|||
'Operating System :: POSIX',
|
||||
'Topic :: Internet',
|
||||
],
|
||||
python_requires='>=3.5',
|
||||
license='GPLv3+',
|
||||
cmdclass=cmdclass,
|
||||
setup_requires=setup_requires,
|
||||
|
|
Loading…
Reference in New Issue