diff --git a/.gitignore b/.gitignore --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ version.txt /resources/repo-linux-to-load.ini /resources/repo-to-load.ini +build/ +dist/ diff --git a/README b/README.md rename from README rename to README.md --- a/README +++ b/README.md @@ -1,9 +1,12 @@ +swh-loader-git +============== + The Software Heritage Git Loader is a tool and a library to walk a local Git repository and inject into the SWH dataset all contained files that weren't known before. License -======= +------- This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the @@ -19,10 +22,9 @@ License along with this program. Dependencies -============ +------------ -Runtime -------- +### Runtime - python3 - python3-dulwich @@ -32,27 +34,26 @@ - python3-swh.storage - python3-swh.scheduler -Test ----- +### Test - python3-nose Requirements -============ +------------ - implementation language, Python3 - coding guidelines: conform to PEP8 - Git access: via dulwich Configuration -============= +------------- You can run the loader or the updater directly by calling: ``` python3 -m swh.loader.git.{loader,updater} ``` -## Location +### Location Both tools expect a configuration file. @@ -63,7 +64,7 @@ Note: Will call that location $SWH_CONFIG_PATH -## Configuration sample +### Configuration sample $SWH_CONFIG_PATH/loader/git-{loader,updater}.yml: ``` diff --git a/setup.py b/setup.py --- a/setup.py +++ b/setup.py @@ -1,8 +1,21 @@ #!/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 import os 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(name=None): if name: @@ -26,6 +39,8 @@ setup( name='swh.loader.git', description='Software Heritage git loader', + 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/DLDG/', @@ -36,4 +51,16 @@ extras_require={'testing': parse_requirements('test')}, 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-loader-git', + }, )