Python Package with common Classes and Utilities used in Minos API Gateway.
Project description
API Gateway Common
Minos is a framework which helps you create reactive microservices in Python. Internally, it leverages Event Sourcing, CQRS and a message driven architecture to fulfil the commitments of an asynchronous environment.
Documentation
The official documentation as well as the API you can find it under https://clariteia.github.io/api_gateway_common/. Please, submit any issue regarding documentation as well!
Set up a development environment
Minos uses poetry
as its default package manager. Please refer to the
Poetry installation guide for instructions on how to install it.
Now you con install all the dependencies by running
make install
In order to make the pre-commits checks available to git, run
pre-commit install
Make yourself sure you are able to run the tests. Refer to the appropriate section in this guide.
Run the tests
In order to run the tests, please make sure you have the Docker Engine and Docker Compose installed.
Move into tests/
directory
cd tests/
Run service dependencies:
docker-compose up -d
Install library dependencies:
make install
Run tests:
make test
How to contribute
Minos being an open-source project, we are looking forward to having your contributions. No matter whether it is a pull request with new features, or the creation of an issue related to a bug you have found.
Please consider these guidelines before you submit any modification.
Create an issue
- If you happen to find a bug, please file a new issue filling the 'Bug report' template.
- Set the appropriate labels, so we can categorise it easily.
- Wait for any core developer's feedback on it.
Submit a Pull Request
- Create an issue following the previous steps.
- Fork the project.
- Push your changes to a local branch.
- Run the tests!
- Submit a pull request from your fork's branch.
Credits
This package was created with and the project template.
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
Built Distribution
Hashes for minos-apigateway-common-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a914418d0740f2c7f39692aa341d8810e1f255a093b5e16c8d64a07b3f76e927 |
|
MD5 | c20566b69342bf28b1a024b42004cf20 |
|
BLAKE2b-256 | 011d230fd6254f8be4a412bf1d26673933c2683ed66d3700cd4135bad8ff5c7e |
Hashes for minos_apigateway_common-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dbc522fcb54fc7f9a598705a8ae5a34addc94665308951ac127b9aa9ed2499dc |
|
MD5 | a656981d77fc3260934813e2b90338b9 |
|
BLAKE2b-256 | df49f38ee7ad8e99a106e2e65025540c59bb16bdf0774eb8d118b8612cc8c8f3 |