Metadata-Version: 2.1
Name: prod-manager
Version: 0.1.3
Summary: Interact with a ProdManager instance
Home-page: https://gitlab.com/prod-manager/prod-manager-api
License: GPL-3.0
Keywords: prod-manager,manager,production,monitor,incident,maintenance
Author: Lunik
Author-email: lunik@tiwabbit.fr
Maintainer: Lunik
Maintainer-email: lunik@tiwabbit.fr
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Dist: requests (>=2.13.0,<3.0.0)
Project-URL: Bug Tracker, https://gitlab.com/prod-manager/prod-manager-api/-/issues
Project-URL: Documentation, https://prod-manager-api.tiwabbit.fr
Project-URL: Repository, https://gitlab.com/prod-manager/prod-manager-api
Description-Content-Type: text/markdown

# 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
