Metadata-Version: 2.1
Name: pilot-platform-common
Version: 0.9.1
Summary: Centralize cross-service functionality shared across all Pilot Platform services.
Author: Indoc Systems
Maintainer: Matvey Loshakov
Maintainer-email: mloshakov@indocresearch.org
Requires-Python: >=3.10,<3.11
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3
Requires-Dist: aioboto3 (>=9.6.0,<=13.2.0)
Requires-Dist: httpx (>=0.23.0,<0.29.0)
Requires-Dist: minio (>=7.1.8,<8.0.0)
Requires-Dist: pyjwt (>=2.6.0,<=2.9.0)
Requires-Dist: python-dotenv (>=0.19.1)
Requires-Dist: redis (>=4.5.0,<=6.2.0)
Requires-Dist: starlette (<0.53.0)
Requires-Dist: xmltodict (>=0.13.0,<=0.14.2)
Description-Content-Type: text/markdown

# common

[![Run Tests](https://github.com/PilotDataPlatform/pilot-hdc-common/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/PilotDataPlatform/pilot-hdc-common/actions/workflows/run-tests.yml)
[![Python](https://img.shields.io/badge/python-3.10-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.


## 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).

## Acknowledgements

Pilot HDC was developed by Indoc Research Europe gGmbH ([info@indocresearch.org](mailto:info@indocresearch.org)) in the context of the HealthDataCloud and eBRAIN-Health projects.

The development of the HealthDataCloud open source software was supported by the EBRAINS research infrastructure, funded from the European Union's Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3) and H2020 Research and Innovation Action Grant Interactive Computing E-Infrastructure for the Human Brain Project ICEI 800858.

The eBRAIN-Health project has received funding from the European Union’s Horizon Europe research and innovation programme under grant agreement No 101058516. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or other granting authorities. Neither the European Union nor other granting authorities can be held responsible for them.

![HDC-EU-acknowledgement](https://hdc.ebrains.eu/img/HDC-EU-acknowledgement.png)

