diff --git a/PKG-INFO b/PKG-INFO index 9e3a092..b94c3d4 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -1,26 +1,29 @@ Metadata-Version: 2.1 Name: swh.counters -Version: 0.2.0 +Version: 0.2.1 Summary: Software Heritage Next gen counters Home-page: https://forge.softwareheritage.org/source/swh-counters Author: Software Heritage developers Author-email: swh-devel@inria.fr License: UNKNOWN Project-URL: Bug Reports, https://forge.softwareheritage.org/maniphest Project-URL: Funding, https://www.softwareheritage.org/donate Project-URL: Source, https://forge.softwareheritage.org/source/swh-counters Project-URL: Documentation, https://docs.softwareheritage.org/devel/swh-counters/ -Description: swh-counters - =============== +Description: .. _swh-counters: - Next generation counters for swh objects + swh-counters + ============ + + Service providing efficient estimates of the number of objects in the SWH archive, using + Redis's Hyperloglog Platform: UNKNOWN Classifier: Programming Language :: Python :: 3 Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) Classifier: Operating System :: OS Independent Classifier: Development Status :: 3 - Alpha Requires-Python: >=3.7 Description-Content-Type: text/markdown Provides-Extra: testing diff --git a/README.md b/README.md deleted file mode 100644 index e9097bc..0000000 --- a/README.md +++ /dev/null @@ -1,4 +0,0 @@ -swh-counters -=============== - -Next generation counters for swh objects diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..de439c9 --- /dev/null +++ b/README.rst @@ -0,0 +1,7 @@ +.. _swh-counters: + +swh-counters +============ + +Service providing efficient estimates of the number of objects in the SWH archive, using +Redis's Hyperloglog diff --git a/docs/README.rst b/docs/README.rst new file mode 100644 index 0000000..de439c9 --- /dev/null +++ b/docs/README.rst @@ -0,0 +1,7 @@ +.. _swh-counters: + +swh-counters +============ + +Service providing efficient estimates of the number of objects in the SWH archive, using +Redis's Hyperloglog diff --git a/docs/index.rst b/docs/index.rst index b04a56d..7466a62 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,19 +1,13 @@ -.. _swh-py-template: - -Software Heritage - Python module template -========================================== - -Python module template, used as skeleton to create new modules. - +.. include:: README.rst .. toctree:: :maxdepth: 2 :caption: Contents: Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`modindex` * :ref:`search` diff --git a/setup.py b/setup.py index 07c7eeb..cb19e76 100755 --- a/setup.py +++ b/setup.py @@ -1,72 +1,72 @@ #!/usr/bin/env python3 # Copyright (C) 2019-2021 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 io import open from os import path from setuptools import find_packages, setup 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: +with open(path.join(here, "README.rst"), encoding="utf-8") as f: long_description = f.read() def parse_requirements(*names): requirements = [] for name in names: if name: reqf = "requirements-%s.txt" % name else: reqf = "requirements.txt" if not path.exists(reqf): return requirements with open(reqf) as f: for line in f.readlines(): line = line.strip() if not line or line.startswith("#"): continue requirements.append(line) return requirements setup( name="swh.counters", description="Software Heritage Next gen counters", long_description=long_description, long_description_content_type="text/markdown", python_requires=">=3.7", author="Software Heritage developers", author_email="swh-devel@inria.fr", url="https://forge.softwareheritage.org/source/swh-counters", packages=find_packages(), # packages's modules install_requires=parse_requirements(None, "swh"), tests_require=parse_requirements("test"), setup_requires=["setuptools-scm"], use_scm_version=True, extras_require={"testing": parse_requirements("test")}, include_package_data=True, entry_points=""" [swh.cli.subcommands] counters=swh.counters.cli """, classifiers=[ "Programming Language :: Python :: 3", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Development Status :: 3 - Alpha", ], project_urls={ "Bug Reports": "https://forge.softwareheritage.org/maniphest", "Funding": "https://www.softwareheritage.org/donate", "Source": "https://forge.softwareheritage.org/source/swh-counters", "Documentation": "https://docs.softwareheritage.org/devel/swh-counters/", }, ) diff --git a/swh.counters.egg-info/PKG-INFO b/swh.counters.egg-info/PKG-INFO index 9e3a092..b94c3d4 100644 --- a/swh.counters.egg-info/PKG-INFO +++ b/swh.counters.egg-info/PKG-INFO @@ -1,26 +1,29 @@ Metadata-Version: 2.1 Name: swh.counters -Version: 0.2.0 +Version: 0.2.1 Summary: Software Heritage Next gen counters Home-page: https://forge.softwareheritage.org/source/swh-counters Author: Software Heritage developers Author-email: swh-devel@inria.fr License: UNKNOWN Project-URL: Bug Reports, https://forge.softwareheritage.org/maniphest Project-URL: Funding, https://www.softwareheritage.org/donate Project-URL: Source, https://forge.softwareheritage.org/source/swh-counters Project-URL: Documentation, https://docs.softwareheritage.org/devel/swh-counters/ -Description: swh-counters - =============== +Description: .. _swh-counters: - Next generation counters for swh objects + swh-counters + ============ + + Service providing efficient estimates of the number of objects in the SWH archive, using + Redis's Hyperloglog Platform: UNKNOWN Classifier: Programming Language :: Python :: 3 Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) Classifier: Operating System :: OS Independent Classifier: Development Status :: 3 - Alpha Requires-Python: >=3.7 Description-Content-Type: text/markdown Provides-Extra: testing diff --git a/swh.counters.egg-info/SOURCES.txt b/swh.counters.egg-info/SOURCES.txt index aff1fe5..7785612 100644 --- a/swh.counters.egg-info/SOURCES.txt +++ b/swh.counters.egg-info/SOURCES.txt @@ -1,48 +1,49 @@ .gitignore .pre-commit-config.yaml AUTHORS CODE_OF_CONDUCT.md CONTRIBUTORS LICENSE MANIFEST.in Makefile -README.md +README.rst mypy.ini pyproject.toml pytest.ini requirements-swh.txt requirements-test.txt requirements.txt setup.cfg setup.py tox.ini docs/.gitignore docs/Makefile +docs/README.rst docs/conf.py docs/index.rst docs/_static/.placeholder docs/_templates/.placeholder swh/__init__.py swh.counters.egg-info/PKG-INFO swh.counters.egg-info/SOURCES.txt swh.counters.egg-info/dependency_links.txt swh.counters.egg-info/entry_points.txt swh.counters.egg-info/requires.txt swh.counters.egg-info/top_level.txt swh/counters/__init__.py swh/counters/cli.py swh/counters/interface.py swh/counters/journal_client.py swh/counters/kafka_client.py swh/counters/py.typed swh/counters/redis.py swh/counters/api/__init__.py swh/counters/api/client.py swh/counters/api/server.py swh/counters/tests/__init__.py swh/counters/tests/conftest.py swh/counters/tests/test_cli.py swh/counters/tests/test_init.py swh/counters/tests/test_journal_client.py swh/counters/tests/test_redis.py swh/counters/tests/test_server.py \ No newline at end of file