This project is in its early development stages. Stability is not guaranteed, and documentation is limited. We welcome your feedback and contributions as we refine and expand this project together!
This Python project aims to facilitate interaction with the Postman platform API.
The package provides the following core Python classes:
- PostmanApi: for direct access to the Postman API features. Takes a Postman API key as input.
- WorkspaceManager: To work with an existing workspace. Takes a PostmanApi and workspace identifier as input.
- CollectionManager: to work with an existing collection. Takes a WorkspaceManager and collection identifier as input.
Additional classes will be implemented to manage requests, folders, and other resources.
This package also includes Python classes to read/write Postman collections based on version 2.1 of the schema. The initial implementation leverages Python data classes. But this is being transitioned into Pydantic-based classes to strengthen features and validation.
This package is a component of the Data Artifex project. It is being released independently of the Data Artifex Postman Toolkit package to allow its use by any developer working with Postman.
Once stable, this package will be officially released and distributed through PyPI. Stay tuned for updates!
In the meantime, you can install the package locally by following these steps:
-
Clone the Repository:
First, clone the repository to your local machine:
git clone <repository-url> cd <repository-directory>
-
Install the Package:
From the project's home directory, run the following command to install the package:
pip install -e .
To use this package, you must have a Postman account and API key.
Until this repository is made public, you must generate the Sphinx documentation locally...
First, ensure the relevant Sphinx packages are installed in your Python environment:
pip install sphinx sphinx sphinx-rtd-theme sphinx-copybutton myst-parser
Then navigate to the docs directory and call make.
If you do not have make installed, you can alternatively call:
sphinx-build -M source build
Upon completion, open the docs/build/index.html file in your browser.
...
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
