Skip to main content

Common library for MEx python projects.

Project description

MEx common

Common library for MEx python projects.

cookiecutter cve-scan documentation linting open-code testing

Project

The Metadata Exchange (MEx) project is committed to improve the retrieval of RKI research data and projects. How? By focusing on metadata: instead of providing the actual research data directly, the MEx metadata catalog captures descriptive information about research data and activities. On this basis, we want to make the data FAIR[^1] so that it can be shared with others.

Via MEx, metadata will be made findable, accessible and shareable, as well as available for further research. The goal is to get an overview of what research data is available, understand its context, and know what needs to be considered for subsequent use.

RKI cooperated with D4L data4life gGmbH for a pilot phase where the vision of a FAIR metadata catalog was explored and concepts and prototypes were developed. The partnership has ended with the successful conclusion of the pilot phase.

After an internal launch, the metadata will also be made publicly available and thus be available to external researchers as well as the interested (professional) public to find research data from the RKI.

For further details, please consult our project page.

[^1]: FAIR is referencing the so-called FAIR data principles – guidelines to make data Findable, Accessible, Interoperable and Reusable.

Contact
For more information, please feel free to email us at mex@rki.de.

Publisher

Robert Koch-Institut
Nordufer 20
13353 Berlin
Germany

Package

The mex-common library is a software development toolkit that is used by multiple components within the MEx project. It contains utilities for building pipelines like a common commandline interface, logging and configuration setup. It also provides common auxiliary connectors that can be used to fetch data from external services and a re-usable implementation of the MEx metadata schema as pydantic models.

License

This package is licensed under the MIT license. All other software components of the MEx project are open-sourced under the same license as well.

Development

Installation

  • install python on your system
  • on unix, run make install
  • on windows, run .\mex.bat install

Linting and testing

  • run all linters with make lint or .\mex.bat lint
  • run unit and integration tests with make test or .\mex.bat test
  • run just the unit tests with make unit or .\mex.bat unit

Updating dependencies

  • update boilerplate files with cruft update
  • update global requirements in requirements.txt manually
  • update git hooks with pre-commit autoupdate
  • update package dependencies using uv sync --upgrade
  • update github actions in .github/workflows/*.yml manually

Creating release

  • run mex release RULE to release a new version where RULE determines which part of the version to update and is one of major, minor, patch.

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

mex_common-1.13.0.tar.gz (88.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mex_common-1.13.0-py3-none-any.whl (136.1 kB view details)

Uploaded Python 3

File details

Details for the file mex_common-1.13.0.tar.gz.

File metadata

  • Download URL: mex_common-1.13.0.tar.gz
  • Upload date:
  • Size: 88.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mex_common-1.13.0.tar.gz
Algorithm Hash digest
SHA256 541c1e00fafcb68e7f3412483add5e1ab5307c6972dfd57e0c89e90c4d74d28e
MD5 5321ab99771ec3d731ac26539c6be50f
BLAKE2b-256 2e4adb76131050d31ec17f856fcc2ece14aa1f2be05e6f642ecdc7ec2bc39923

See more details on using hashes here.

Provenance

The following attestation bundles were made for mex_common-1.13.0.tar.gz:

Publisher: release.yml on robert-koch-institut/mex-common

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mex_common-1.13.0-py3-none-any.whl.

File metadata

  • Download URL: mex_common-1.13.0-py3-none-any.whl
  • Upload date:
  • Size: 136.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mex_common-1.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b999b8b8d7544eb434ac4927d17b59f742099de5a37a208eeb06ae0b42a9b1f
MD5 f0a6e4d55ddcb17c6ec9f0ef70a35d9d
BLAKE2b-256 c745f071b95f02c6b3abe8a085bfc8113b850f643410b8434be8adb6b32d54d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for mex_common-1.13.0-py3-none-any.whl:

Publisher: release.yml on robert-koch-institut/mex-common

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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