ghga-service-commons
This Python library serves as a collection of common utilities used by the microservices developed at German Human Genome-Phenome Archive (GHGA).
It collects boilerplate code for common functionalities such as API server setup, authentication and authorization.
This library is primarily intended for internal use at GHGA and should not be seen as a general-purpose microservice chassis. However, if this library matches your specific needs as well, please feel free to use it. It is open source.
Installation
This package is available at PyPI: https://pypi.org/project/ghga_service_commons
You can install it from there using:
pip install ghga_service_commons
Thereby, you may specify following extra(s):
api: dependencies needed to use the API server functionalitiesauth: dependencies needed for dealing with authentication and authorization
Development
For setting up the development environment, we rely on the devcontainer feature of vscode.
To use it, you have to have Docker as well as vscode with its "Remote - Containers"
extension (ms-vscode-remote.remote-containers) extension installed.
Then, you just have to open this repo in vscode and run the command
Remote-Containers: Reopen in Container from the vscode "Command Palette".
This will give you a full-fledged, pre-configured development environment including:
- infrastructural dependencies of the service (databases, etc.)
- all relevant vscode extensions pre-installed
- pre-configured linting and auto-formatting
- a pre-configured debugger
- automatic license-header insertion
Moreover, inside the devcontainer, there is following convenience command available (please type it in the integrated terminal of vscode):
dev_install- install the lib with all development dependencies and pre-commit hooks (please run that if you are starting the devcontainer for the first time or if added any python dependencies to the./pyproject.toml)
If you prefer not to use vscode, you could get a similar setup (without the editor specific features) by running the following commands:
# Execute in the repo's root dir:
cd ./.devcontainer
# build and run the environment with docker-compose
docker build -t ghga-service-commons .
docker run -it ghga-service-commons /bin/bash
License
This repository is free to use and modify according to the Apache 2.0 License.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ghga_service_commons-3.3.0.tar.gz.
File metadata
- Download URL: ghga_service_commons-3.3.0.tar.gz
- Upload date:
- Size: 34.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c5091f1f0fb1e4679e9c97652a738642b5daa3a00c48d8985c48d605a831a36a
|
|
| MD5 |
d6d38a1ce701e83bd218c68bea007712
|
|
| BLAKE2b-256 |
713bd52a8299552d7816a20a0f422c7ab54ffb1b1a34132a6ab6413c807b576b
|
File details
Details for the file ghga_service_commons-3.3.0-py3-none-any.whl.
File metadata
- Download URL: ghga_service_commons-3.3.0-py3-none-any.whl
- Upload date:
- Size: 59.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
893cdea7903c24920ab472853e928b879aec33f4e74216c2d3ecacaca7569395
|
|
| MD5 |
39d81fa39ec39cef2c23ba1724a9ec9e
|
|
| BLAKE2b-256 |
60d0c132551b9f9f1f453c22797a896ed88941395edd94266576462cbff83b94
|
