Gordo client
Project description
Gordo client
Table of Contents
Client for Gordo project.
Documentation is available on Read the Docs
Installation
At least python 3.9 need to be installed in the system first.
In order to install or uninstall this library run following commands.
# Install
pip install gordo-client
# Uninstall
pip uninstall gordo-client
Developers Instructions
Setup
Install poetry.
Setup and run development shell instance:
> poetry install
> poetry shell
You could also install and apply pre-commit hooks.
Run poetry install
to install or re-install all dependencies.
Run poetry update
to update the locked dependencies to the most recent
version, honoring the constrains put inside pyproject.toml
.
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"
Contributing
We 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for gordo_client-6.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f246a9746db8bae23bb39284bf724d73dfb80423f666c23247eab83963f95946 |
|
MD5 | 3aab600c62045aaaed6809ff41596242 |
|
BLAKE2b-256 | b3c85748dfd4fb4dcabad9b7bf8f2e862542274889d3f6753e87c32def01dbd5 |