# ProdManager API
`prod-manager` is a Python package providing access to the [ProdManager][prodmanager] API.
## Features
`prod-manager` enables you to:
- write Pythonic code to manage your [ProdManager][prodmanager] resources.
- pass arbitrary parameters to the [ProdManager][prodmanager] API. Simply follow [ProdManager][prodmanager]’s docs on what parameters are available.
- access arbitrary endpoints as soon as they are available on [ProdManager][prodmanager], by using lower-level API methods.
- use persistent requests sessions for authentication, proxy and certificate handling.
- flexible handling of paginated responses, including lazy iterators.
## Installation
`prod-manager` is compatible with Python 3.7+.
Use `pip` to install the latest stable version of `prod-manager`:
```bash
$ pip install --upgrade prod-manager
```
The current development version is available on GitLab.com, and can be installed directly from the git repository:
```bash
$ pip install git+https://gitlab.com/prod-manager/prod-manager-api.git
```
## Bug reports
Please report bugs and feature requests at <https://gitlab.com/prod-manager/prod-manager-api/-/issues>.
## Documentation
The full documentation for CLI and API is available on [GitLab Pages][documentation-url].
### Build the docs
We use `mkdocs` to manage our environment and build the documentation :
```bash
$ poetry install --only docs
$ mkdocs build
```
## Contributing
For guidelines for contributing to `prod-manager`, refer to [CONTRIBUTING.md](./CONTRIBUTING.md).
<!-- Links -->
[documentation-url]: https://prod-manager-api.tiwabbit.fr
[prodmanager]: https://gitlab.com/prod-manager/prod-manager
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/prod-manager/prod-manager-api",
"name": "prod-manager",
"maintainer": "Lunik",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "lunik@tiwabbit.fr",
"keywords": "prod-manager,manager,production,monitor,incident,maintenance",
"author": "Lunik",
"author_email": "lunik@tiwabbit.fr",
"download_url": "https://files.pythonhosted.org/packages/f0/f3/39555ae001ae3da83e3c5a11f6c6615a147770b6f4608849b3fe7415d487/prod_manager-0.2.0.tar.gz",
"platform": null,
"description": "# ProdManager API\n\n`prod-manager` is a Python package providing access to the [ProdManager][prodmanager] API.\n\n## Features\n\n`prod-manager` enables you to:\n\n- write Pythonic code to manage your [ProdManager][prodmanager] resources.\n- pass arbitrary parameters to the [ProdManager][prodmanager] API. Simply follow [ProdManager][prodmanager]\u2019s docs on what parameters are available.\n- access arbitrary endpoints as soon as they are available on [ProdManager][prodmanager], by using lower-level API methods.\n- use persistent requests sessions for authentication, proxy and certificate handling.\n- flexible handling of paginated responses, including lazy iterators.\n\n## Installation\n\n`prod-manager` is compatible with Python 3.7+.\n\nUse `pip` to install the latest stable version of `prod-manager`:\n\n```bash\n$ pip install --upgrade prod-manager\n```\n\nThe current development version is available on GitLab.com, and can be installed directly from the git repository:\n\n```bash\n$ pip install git+https://gitlab.com/prod-manager/prod-manager-api.git\n```\n\n## Bug reports\n\nPlease report bugs and feature requests at <https://gitlab.com/prod-manager/prod-manager-api/-/issues>.\n\n## Documentation\n\nThe full documentation for CLI and API is available on [GitLab Pages][documentation-url].\n\n### Build the docs\n\nWe use `mkdocs` to manage our environment and build the documentation :\n\n```bash\n$ poetry install --only docs\n$ mkdocs build\n```\n\n## Contributing\n\nFor guidelines for contributing to `prod-manager`, refer to [CONTRIBUTING.md](./CONTRIBUTING.md).\n\n\n<!-- Links -->\n[documentation-url]: https://prod-manager-api.tiwabbit.fr\n[prodmanager]: https://gitlab.com/prod-manager/prod-manager",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "Interact with a ProdManager instance",
"version": "0.2.0",
"split_keywords": [
"prod-manager",
"manager",
"production",
"monitor",
"incident",
"maintenance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b791f55465cfbd4f9560ffa8f62b139b67857c99b13a2945d3490dfbde7f879c",
"md5": "c4c4384af845d733832ee895046913ee",
"sha256": "946d0861f3c23b1829514965567ccf8bb695660f9b926e11e51246b8b30fdefb"
},
"downloads": -1,
"filename": "prod_manager-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4c4384af845d733832ee895046913ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 4365,
"upload_time": "2023-02-05T22:27:00",
"upload_time_iso_8601": "2023-02-05T22:27:00.228560Z",
"url": "https://files.pythonhosted.org/packages/b7/91/f55465cfbd4f9560ffa8f62b139b67857c99b13a2945d3490dfbde7f879c/prod_manager-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f0f339555ae001ae3da83e3c5a11f6c6615a147770b6f4608849b3fe7415d487",
"md5": "9cefad706843ddd733e3ece6d871a0de",
"sha256": "01cde48641ff9905099a093b8db704a8a9a75c6f3b22d9fa609bed2677affdf3"
},
"downloads": -1,
"filename": "prod_manager-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "9cefad706843ddd733e3ece6d871a0de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 3833,
"upload_time": "2023-02-05T22:27:02",
"upload_time_iso_8601": "2023-02-05T22:27:02.317953Z",
"url": "https://files.pythonhosted.org/packages/f0/f3/39555ae001ae3da83e3c5a11f6c6615a147770b6f4608849b3fe7415d487/prod_manager-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-05 22:27:02",
"github": false,
"gitlab": true,
"bitbucket": false,
"gitlab_user": "prod-manager",
"gitlab_project": "prod-manager-api",
"lcname": "prod-manager"
}
JSON