Metadata-Version: 2.3
Name: pilot-platform-common
Version: 2.16.0
Summary: Common package used by various Pilot microservices.
Author: Indoc Systems
Author-email: support@indocsystems.com
Requires-Python: >=3.10,<3.13
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: aioboto3 (>=14.3.0,<15.0.0)
Requires-Dist: cryptography (>=44.0.2,<45.0.0)
Requires-Dist: dicttoxml (>=1.7.16,<2.0.0)
Requires-Dist: httpx (>=0.28.1,<0.29.0)
Requires-Dist: opentelemetry-instrumentation-fastapi (>=0.55b1,<0.56)
Requires-Dist: opentelemetry-sdk (>=1.32.1,<2.0.0)
Requires-Dist: pydantic (>=2.7.1,<3.0.0)
Requires-Dist: pyjwt (>=2.10.1,<3.0.0)
Requires-Dist: python-dotenv (>=0.19.1)
Requires-Dist: python-json-logger (>=0.1.11,<=2.02)
Requires-Dist: redis (>=4.5.0,<7.0.0)
Requires-Dist: starlette (>=0.40.0,<0.47.0)
Requires-Dist: xmltodict (>=0.14.2,<0.15.0)
Description-Content-Type: text/markdown

# common

[![Run Tests](https://github.com/PilotDataPlatform/common/actions/workflows/run-tests.yml/badge.svg?branch=develop)](https://github.com/PilotDataPlatform/common/actions/workflows/run-tests.yml)
[![Python](https://img.shields.io/badge/python-3.12-brightgreen.svg)](https://www.python.org/)
[![PyPI](https://img.shields.io/pypi/v/pilot-platform-common.svg)](https://pypi.org/project/pilot-platform-common/)

Importable package responsible for cross-service tasks within the Pilot Platform (e.g. logging, Vault connection, etc.).


## Getting Started

### Installation & Quick Start
The latest version of the common package is available on [PyPi](https://pypi.org/project/pilot-platform-common/) and can be installed into another service via Pip.

Pip install from PyPi:
```
pip install pilot-platform-common
```

In `pyproject.toml`:
```
pilot-platform-common = "^<VERSION>"
```

Pip install from a local `.whl` file:
```
pip install pilot_platform_common-<VERSION>-py3-none-any.whl
```

## Contribution

You can contribute the project in following ways:

* Report a bug.
* Suggest a feature.
* Open a pull request for fixing issues or adding functionality. Please consider using [pre-commit](https://pre-commit.com) in this case.
* For general guidelines on how to contribute to the project, please take a look at the [contribution guide](CONTRIBUTING.md).

