diff --git a/.gitignore b/.gitignore --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ .coverage .eggs/ __pycache__ -dist +build/ +dist/ *.egg-info version.txt diff --git a/README.db_testing b/README.db_testing deleted file mode 100644 --- a/README.db_testing +++ /dev/null @@ -1,17 +0,0 @@ -Running database-related tests -============================== - -Python tests for this module include tests that cannot be run without a local -Postgres database. You are not obliged to run those tests though: - -- `make test`: will run all tests -- `make test-nodb`: will run only tests that do not need a local DB -- `make test-db`: will run only tests that do need a local DB - -If you do want to run DB-related tests, you should: - -- ensure that your user is authorized to create and drop DBs, and in particular - DBs named "softwareheritage-test" and "softwareheritage-dev" - -- ensure that you have the storage testdata repository checked out in - ../swh-storage-testdata diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +swh-archiver +============ + +Orchestrator in charge of guaranteeing that object storage content is pristine +and available in a sufficient amount of copies. + +Tests +----- + +Python tests for this module include tests that cannot be run without a local +Postgres database. You are not obliged to run those tests though: + +- `make test`: will run all tests +- `make test-nodb`: will run only tests that do not need a local DB +- `make test-db`: will run only tests that do need a local DB + +If you do want to run DB-related tests, you should ensure you have access zith +sufficient privileges to a Postgresql database. + +### Using your system database + +You need to: + +- ensure that your user is authorized to create and drop DBs, and in particular + DBs named "softwareheritage-test" and "softwareheritage-dev" + +- ensure that you have the storage testdata repository checked out in + ../swh-storage-testdata + +### Using pifpaf + +[pifpaf](https://github.com/jd/pifpaf) is a suite of fixtures and a +command-line tool that allows to start and stop daemons for a quick throw-away +usage. + +It can be used to run tests that need a Postgres database without any other +configuration reauired nor the need to have special access to a running +database: + +```bash + +$ pifpaf run postgresql make test-db +[snip] +---------------------------------------------------------------------- +Ran 12 tests in 0.903s + +OK +``` + +Note that pifpaf is not yet available as a Debian package, so you may have to +install it in a venv. diff --git a/setup.py b/setup.py --- a/setup.py +++ b/setup.py @@ -1,7 +1,20 @@ #!/usr/bin/env python3 +# Copyright (C) 2015-2018 The Software Heritage developers +# See the AUTHORS file at the top-level directory of this distribution +# License: GNU General Public License version 3, or any later version +# See top-level LICENSE file for more information from setuptools import setup, find_packages +from os import path +from io import open + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, 'README.md'), encoding='utf-8') as f: + long_description = f.read() + def parse_requirements(): requirements = [] @@ -18,6 +31,8 @@ setup( name='swh.archiver', description='Software Heritage archiver', + long_description=long_description, + long_description_content_type='text/markdown', author='Software Heritage developers', author_email='swh-devel@inria.fr', url='https://forge.softwareheritage.org/diffusion/DARC/', @@ -26,4 +41,16 @@ setup_requires=['vcversioner'], vcversioner={}, include_package_data=True, + classifiers=[ + "Programming Language :: Python :: 3", + "Intended Audience :: Developers", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: OS Independent", + "Development Status :: 5 - Production/Stable", + ], + project_urls={ + 'Bug Reports': 'https://forge.softwareheritage.org/maniphest', + 'Funding': 'https://www.softwareheritage.org/donate', + 'Source': 'https://forge.softwareheritage.org/source/swh-archiver', + }, )