diff --git a/MANIFEST.in b/MANIFEST.in index aae9579..8b13789 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1 @@ -recursive-exclude tests * + diff --git a/README.md b/README.rst similarity index 58% rename from README.md rename to README.rst index 3b25dea..eb8214c 100644 --- a/README.md +++ b/README.rst @@ -1,14 +1,20 @@ -# metashield-clean-up-sdk-python # +============================== +Metashield-clean-up-sdk-python +============================== -## Installation ## +Installation +============ -Install from command line: +Install the ``metashield_clean_up`` package using pip:: - python setup.py install + pip install metashield_clean_up -## Usage ## +Usage +===== -Example for cleaning a file: +Example for cleaning a file. + +.. code-block:: python import metashield_clean_up @@ -17,10 +23,11 @@ Example for cleaning a file: response = api.get_clean_result(response.data["resultId"]) -## Run tests ## +Run tests +========= Before run tests, replace some settings in *tests/settings_default.py* module. -Tests was built with Python Unittest, run the following commands: +Tests was built with Python Unittest, run the following commands:: python -m unittest discover tests diff --git a/setup.py b/setup.py index 3728f28..7cb8ab5 100644 --- a/setup.py +++ b/setup.py @@ -14,8 +14,10 @@ def read_file(filepath): name='metashield_clean_up', version=__version__, description='Metashield Clean-up Online API SDK', - long_description=read_file('README.md'), + long_description=read_file('README.rst'), author='Eleven Paths', + author_email='metashield-support@support.elevenpaths.com', + url='https://github.com/ElevenPaths/metashield-clean-up-sdk-python', install_requires=read_file('requirements.txt').splitlines(), keywords=['sdk', 'api', 'client', 'clean-up', 'metashield'], license='BSD',