diff --git a/.gitignore b/.gitignore --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,6 @@ .eggs/ __pycache__ *.egg-info/ -version.txt \ No newline at end of file +build/ +dist/ +version.txt diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +swh-journal +=========== + +Persistent logger of changes to the archive, with publish-subscribe support. + +See the +[documentation](https://docs.softwareheritage.org/devel/swh-journal/index.html#software-heritage-journal) +for more details. diff --git a/setup.py b/setup.py old mode 100644 new mode 100755 --- a/setup.py +++ b/setup.py @@ -1,5 +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 = [] @@ -12,16 +27,31 @@ requirements.append(line) return requirements + setup( name='swh.journal', description='Software Heritage Journal utilities', + 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/DJNL/', - packages=find_packages(), # packages's modules - scripts=[], # scripts to package + packages=find_packages(), + scripts=[], install_requires=parse_requirements(), 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-core', + }, )