commit bab1f33c54c29244cb33f169acf3a047c1e1a683 Author: juga0 juga@riseup.net Date: Fri Jul 6 09:22:56 2018 +0000

Add package metadata

and add a simple first sentence about what this program does. --- README.md | 3 +++ setup.py | 29 ++++++++++++++++------------- 2 files changed, 19 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md index a066d0c..74da116 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@

[%5D(https:/...)

+`simple-bw-scanner` (also called `sbws`) is a Tor bandwidth scanner that +produces bandwidth measurements files to be used by Directory Authorities. + It doesn't get simpler than this, folks.

The scanner builds two hop circuits consisting of the relay being measured and diff --git a/setup.py b/setup.py index 738be70..e009a7b 100755 --- a/setup.py +++ b/setup.py @@ -8,10 +8,10 @@ import os

here = os.path.abspath(os.path.dirname(__file__))

-# Causes the lint Travis builds to fail for some reason, so just going to -# remove the long description for now. -# with open(os.path.join(here, 'README.md'), encoding='utf-8') as f: -# long_description = f.read() + +def long_description(): + with open(os.path.join(here, 'README.md'), encoding='utf-8') as f: + return f.read()

def get_package_data(): @@ -44,18 +44,22 @@ setup( name='sbws', version=find_version(), description='Simple Bandwidth Scanner', - # long_description=long_description, + long_description=long_description(), + long_description_content_type="text/markdown", author='Matt Traudt', author_email='pastly@torproject.org', license='CC0', - # https://packaging.python.org/tutorials/distributing-packages/#id48 - # https://pypi.python.org/pypi?%3Aaction=list_classifiers + url="https://gitweb.torproject.org/sbws.git", classifiers=[ - # How mature is this project? Common values are - # 3 - Alpha - # 4 - Beta - # 5 - Production/Stable 'Development Status :: 4 - Beta', + "Environment :: Console", + 'Intended Audience :: Developers', + 'Intended Audience :: System Administrators', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Topic :: System :: Networking', ], packages=find_packages(), include_package_data=True, @@ -63,9 +67,8 @@ setup( 'sbws': get_package_data(), }, data_files=get_data_files(), - keywords='', + keywords='tor onion bandwidth measurements scanner relay circuit', python_requires='>=3.4.5', - # test_suite='test', entry_points={ 'console_scripts': [ 'sbws = sbws.sbws:main',