Skip to main content

A library to use postman collection V2.1 in python.

Project description

PostPyGraphQL

PostPyGraphQL is a library for Postman that run Postman's collections. Originally was forked from https://github.com/matkapi/postpy2 and updated for using body mode GraphQL. If you are using postman, but collection runner is not flexible enough for you and postman codegen is too boring, PostPyGraphQL is here for your continuous integration.

Why use PostPyGraphQL 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 PostPyGraphQL, you don't need to generate code. Just export collection with Postman and use it with PostPyGraphQL.
  • In code generation, you don't have environment feature anymore and variables are hard coded.

Why user PostPyGraphQL instead of Postman collection runner?

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

How to install?

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

$ pip install postpygraphql

How to use?

Import postpygraphql

from postpygraphql.core import PostPython

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

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

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 environment variables

In PostPyGraphQL you can load environmental variables from postman environment files

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

Variable assignment

In PostPyGraphQL 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'})

AttributeError

Since RequestMethods and get_request does not really exists your intelligent IDE cannot help you. So PostPyGraphQL 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.7/site-packages/postpygraphql/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 PostPyGraphQL a star to encourage me to continue its development.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

postpygraphql-0.0.3.tar.gz (17.6 kB view hashes)

Uploaded source

Built Distribution

postpygraphql-0.0.3-py3-none-any.whl (18.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page