Postpy2

Postpy2 is a library for Postman that run Postman's collections. Originaly was forked from https://github.com/k3rn3l-p4n1c/postpython and updated to Postman collection v2.1 format. If you are using postman, but collection runner is not flexible enough for you and postman codegen is too boring, Postpy2 is here for your continuous integration.

Why use Postpy2 instead of postman codegen?

• Postman codegen should be applied one by one for each request and it's boring when your API changes, but with Postpy2, you don't need to generate code. Just export collection with Postman and use it with Postpy2.
• In code generation, you don't have environment feature anymore and variables are hard coded.

Why user Postpy2 instead of Postman collection runner?

• With Postpy2, you write your own script. But collection runner just turns all your requests one by one. So with Postpy2, you can design more complex test suites.

How to install?

Postpy2 is available on PyPI and you can install it using pip:

$ pip install Postpy2

How to use?

Import Postpy2

from postpy2.core import PostPython

Make an instance from PostPython and give the address of postman collection file.

runner = PostPython('/path/to/collection/postman_collection.json')

Now you can call your request. Folders' name change to upper camel case and requests' name change to lowercase form. In this example the name of folder is "Request Methods" and it's change to RequestMethods and the name of request was "GET Request" and it's change to get_request. So you should call a function like runner.YourFolderName.you_request_name()

response = runner.RequestMethods.get_request()
print(response.json())
print(response.status_code)

Load enviroment variables

In Postpy2 you can load enviromental variables from postman enviroment files

pp.environments.load('environments/test.postman_environment.json')

Variable assignment

In Postpy2 you can assign values to environment variables in runtime.

runner.environments.update({'BASE_URL': 'http://127.0.0.1:5000'})
runner.environments.update({'PASSWORD': 'test', 'EMAIL': 'you@email.com'})

Override Request Parameters

It may be useful to override request parameters at runtime. You can do this using the request_overrides option:

headers  = { "MyHeader": "Value" }
pp = PostPython('collections/tests.postman_collection.json', request_overrides={
    'headers': headers
})

AttributeError

Since RequestMethods and get_request does not really exists your intelligent IDE cannot help you. So Postpy2 tries to correct your mistakes. If you spell a function or folder wrong it will suggest you the closest name.

>>> response = runner.RequestMethods.get_requasts()

Traceback (most recent call last):
File "test.py", line 11, in <module>
response = runner.RequestMethods.get_requasts()
File "/usr/local/lib/python3.5/site-packages/Postpy2/core.py", line 73, in **getattr**
'Did you mean %s' % (item, self.name, similar))
AttributeError: get_requasts request does not exist in RequestMethods folder.
Did you mean get_request

You can also use help() method to print all available requests.

>>> runner.help()
>>> Posible requests:
>>> runner.AuthOthers.hawk_auth()
>>> runner.AuthOthers.basic_auth()
>>> runner.AuthOthers.oauth1_0_verify_signature()
>>> runner.RequestMethods.get_request()
>>> runner.RequestMethods.put_request()
>>> runner.RequestMethods.delete_request()
>>> runner.RequestMethods.post_request()
>>> runner.RequestMethods.patch_request()
>>> ...

>>> runner.RequestMethods.help()
>>> runner.RequestMethods.delete_request()
>>> runner.RequestMethods.patch_request()
>>> runner.RequestMethods.get_request()
>>> runner.RequestMethods.put_request()
>>> runner.RequestMethods.post_request()

Contribution

Feel free to share your ideas or any problems in issues. Contributions are welcomed. Give Postpy2 a star to encourage me to continue its development.

Setup

Assuming you are at the root of the repository and sourced a virtual environment:

python -m pip install -r requirements.txt
python -m pip install -r requirements-dev.txt

python -m pytest --cov=$(pwd)/postpy2 --cov-fail-under=85

or use scripts/run_tests.sh