Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add some setup metadata #2

Merged
merged 1 commit into from
Oct 4, 2017
Merged

add some setup metadata #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MANIFEST.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
recursive-exclude tests *

23 changes: 15 additions & 8 deletions README.md → README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
4 changes: 3 additions & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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='[email protected]',
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',
Expand Down