This project has been archived by its maintainers, and is no longer receiving any updates.
GHGA Event Schemas
A package that collects schemas used for events published from and subscribed by GHGA service.
Quick Start
Installation
This package is available at PyPI: https://pypi.org/project/ghga-event-schemas
You can install it from there using:
pip install ghga-event-schemas
Thereby, you may specify following extra(s):
dev: dependencies needed for development and testing
Development
For setting up the development environment, we rely on the devcontainer feature of vscode in combination with Docker Compose.
To use it, you have to have Docker Compose as well as vscode with its "Remote - Containers" extension (ms-vscode-remote.remote-containers) installed.
Then open this repository 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 (databases, etc.)
- all relevant vscode extensions pre-installed
- pre-configured linting and auto-formating
- a pre-configured debugger
- automatic license-header insertion
Moreover, inside the devcontainer, there if following convenience commands available
(please type it in the integrated terminal of vscode):
dev_install - installs the package with all development dependencies and installs pre-commit
(please run that if you are starting the devcontainer for the first time
or if you 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-compose up
# attach to the main container:
# (you can open multiple shell sessions like this)
docker exec -it devcontainer_app_1 /bin/bash
License
This repository is free to use and modify according to the Apache 2.0 License.
1 maintainer
Release files for ghga-event-schemas 0.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ghga_event_schemas-0.11.0.tar.gz | 10.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ghga_event_schemas-0.11.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.7 kB
Release files / ghga_event_schemas-0.11.0.tar.gz
| Download URL | ghga_event_schemas-0.11.0.tar.gz |
|---|---|
| Size | 10.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
96f9a2aa54a96e83a68bafa2b03e8cff2b6a903162137fcbfbbcf030517f3390
|
|
BLAKE2b-256 checksum How to use checksums |
2889d5a0d26588d9805b57a917f40cfcf8eb53626d4b857c7d17143822f3890a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / ghga_event_schemas-0.11.0-py3-none-any.whl
| Download URL | ghga_event_schemas-0.11.0-py3-none-any.whl |
|---|---|
| Size | 13.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8e4aef7a261a6a4f0f664709319ccae2045a836fab30eb3c4a99726c3f2af20f
|
|
BLAKE2b-256 checksum How to use checksums |
8387918dcba2310f69375bb19a87c216be312c0d8a74f2919911873cc6324a1f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
