Gordo core library.

Archival Notice

Date: 26.03.2025

Reason: This repository has been archived due to changes in the project's architecture. The current implementation is no longer maintained and developed.

Table of Contents

• Installation
• Developers Instructions
  • Setup
  • Pre-commit
  • Run tests
• Contributing

---

The main component can be found here.

Documentation is available on Read the Docs

Installation

At least python 3.10 need to be installed in the system first.

pip3 install gordo-core

Developers Instructions

Setup

Install poetry.

Setup and run development shell instance:

> poetry install
> poetry shell

Pre-commit

You could also install and apply pre-commit hooks.

Run tests

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 watch

Contributing

We welcome contributions to this project! To get started, please follow these steps:

1. 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

2. Create a new branch for your feature or bug fix.

git checkout -b your-feature-or-bugfix-branch

3. Make your changes and commit them with a descriptive message.

git commit -m "Add a new feature" -a

4. Push your changes to your forked repository.

git push origin your-feature-or-bugfix-branch

5. 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.