diff --git a/.gitignore b/.gitignore index 8d35cb3..a544251 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ __pycache__ *.pyc +provoj.egg-info +dist +build diff --git a/README.md b/README.md index c7f4f80..3b5f0b2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # provoj -Simple library to check the endpoints of an RESTful API. +Simple library to test the endpoints of an RESTful API. + +Check values, integrated with requests python library. + +For python version>3 + +## Installation + +Requires to have installed 'requests' library. + +Install provoj by: +``` +pip install provoj +``` ### Usage Import the provoj library, and the requests library @@ -51,7 +64,7 @@ test.length("checking the length of the array animals", animals, 3)# test.length Check for request status ```python r = requests.get("https://api.github.com/users/arnaucode/repos") -test.status("get api.github.com/users/arnaucode/repos", r)# test.status(check description, request_response) +test.rStatus("get api.github.com/users/arnaucode/repos", r)# test.rStatus(check description, request_response) ``` ### Full example diff --git a/provoj.py b/provoj/__init__.py similarity index 99% rename from provoj.py rename to provoj/__init__.py index 233c585..0528710 100644 --- a/provoj.py +++ b/provoj/__init__.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python import math import datetime diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..b2da542 --- /dev/null +++ b/setup.py @@ -0,0 +1,12 @@ +from setuptools import setup + +setup( + name='provoj', + packages=['provoj'], + description='Simple library to test the endpoints of an RESTful API.', + url='https://github.com/arnaucode/provoj', + author='arnaucode', + author_email='arnaucode@gmail.com', + version='0.0.0.1', + scripts=['provoj/__init__.py'] +)