The main component can be found here.
Documentation is available on Read the Docs
At least python 3.10 need to be installed in the system first.
pip3 install gordo-core
Install poetry.
Setup and run development shell instance:
> poetry install
> poetry shellYou could also install and apply pre-commit hooks.
Install docker (or similar container manager) if you want to run test-suite.
Run tests (except docker-related ones):
> poetry run pytest -n auto -m "not dockertest"Run docker-related tests:
> poetry run pytest -m "dockertest"Build documentation:
> cd docs/
> poetry run make watchWe welcome contributions to this project! To get started, please follow these steps:
- Fork this repository to your own GitHub account and then clone it to your local device.
git clone https://github.com/your-account/your-project.git
- Create a new branch for your feature or bug fix.
git checkout -b your-feature-or-bugfix-branch
- Make your changes and commit them with a descriptive message.
git commit -m "Add a new feature" -a
- Push your changes to your forked repository.
git push origin your-feature-or-bugfix-branch
- Open a pull request in this repository and describe the changes you made.
We'll review your changes and work with you to get them merged into the main branch of the project.