Skip to main content

A library that contains common functionality used in services of GHGA

Project description

tests PyPI version shields.io PyPI pyversions Coverage Status

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 functionalities
  • auth: 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 ./setup.cfg)

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ghga_service_commons-1.3.0.tar.gz (30.8 kB view details)

Uploaded Source

Built Distribution

ghga_service_commons-1.3.0-py3-none-any.whl (53.4 kB view details)

Uploaded Python 3

File details

Details for the file ghga_service_commons-1.3.0.tar.gz.

File metadata

  • Download URL: ghga_service_commons-1.3.0.tar.gz
  • Upload date:
  • Size: 30.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for ghga_service_commons-1.3.0.tar.gz
Algorithm Hash digest
SHA256 1582b251052163640d0c609d90d1e51e2d14902909e889e36d50a3a0be239e00
MD5 26190c028ed0826fece4cce96b716486
BLAKE2b-256 c3f079621c5e2f45c5b6b3953b2b4a6b04b663dc088e9e5f78723d1eeeffe20d

See more details on using hashes here.

File details

Details for the file ghga_service_commons-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ghga_service_commons-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 717216804aa8dac5e069dabaf796d47efde279ac00c45b2d17b0f720019d9b2c
MD5 5b4a035886ceb38e315a250bbcecd2d5
BLAKE2b-256 cce83454c90b244672fe07d6ec531bd8c343c4cab9bc65cc9cce7a6d7908d816

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page