[](https://developer.equinor.com/governance/scm-policy/)
# Gordo core library.
# Table of Contents
* [Installation](#Installation)
* [Developers Instructions](#Developers-Instructions)
* [Setup](#Setup)
* [Pre-commit](#Pre-commit)
* [Run tests](#Run-tests)
* [Contributing](#Contributing)
---
The main component can be found [here](https://github.com/equinor/gordo).
[Documentation is available on Read the Docs](https://gordo-core.readthedocs.io/)
## Installation
At least python 3.10 need to be installed in the system first.
```
pip3 install gordo-core
```
## Developers Instructions
### Setup
Install [poetry](https://python-poetry.org/docs/#installation).
Setup and run development shell instance:
```console
> poetry install
> poetry shell
```
### Pre-commit
You could also install and apply [pre-commit](https://pre-commit.com/#usage) hooks.
### Run tests
Install [docker](https://docs.docker.com/engine/install/) (or similar container manager) if you want to run test-suite.
Run tests (except docker-related ones):
```console
> poetry run pytest -n auto -m "not dockertest"
```
Run docker-related tests:
```console
> poetry run pytest -m "dockertest"
```
Build documentation:
```console
> 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/equinor/gordo-core",
"name": "gordo-core",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "gordo-core",
"author": "Equinor ASA",
"author_email": "fg_gpl@equinor.com",
"download_url": null,
"platform": null,
"description": "[](https://developer.equinor.com/governance/scm-policy/)\n\n# Gordo core library.\n\n# Table of Contents\n* [Installation](#Installation)\n* [Developers Instructions](#Developers-Instructions)\n\t* [Setup](#Setup)\n\t* [Pre-commit](#Pre-commit)\n\t* [Run tests](#Run-tests)\n* [Contributing](#Contributing)\n\n---\n\nThe main component can be found [here](https://github.com/equinor/gordo).\n\n[Documentation is available on Read the Docs](https://gordo-core.readthedocs.io/)\n\n## Installation\n\nAt least python 3.10 need to be installed in the system first.\n\n```\npip3 install gordo-core\n```\n\n## Developers Instructions\n\n### Setup\n\nInstall [poetry](https://python-poetry.org/docs/#installation).\n\nSetup and run development shell instance:\n\n```console\n> poetry install\n> poetry shell\n```\n### Pre-commit\n\nYou could also install and apply [pre-commit](https://pre-commit.com/#usage) hooks.\n\n### Run tests\n\nInstall [docker](https://docs.docker.com/engine/install/) (or similar container manager) if you want to run test-suite.\n\nRun tests (except docker-related ones):\n\n```console\n> poetry run pytest -n auto -m \"not dockertest\"\n```\n\nRun docker-related tests:\n```console\n> poetry run pytest -m \"dockertest\"\n```\n\nBuild documentation:\n```console\n> cd docs/\n> poetry run make watch\n```\n\n## Contributing\nWe welcome contributions to this project! To get started, please follow these steps:\n\n1. Fork this repository to your own GitHub account and then clone it to your local device.\n\n```\ngit clone https://github.com/your-account/your-project.git\n```\n\n2. Create a new branch for your feature or bug fix.\n\n```\ngit checkout -b your-feature-or-bugfix-branch\n```\n\n3. Make your changes and commit them with a descriptive message.\n\n```\ngit commit -m \"Add a new feature\" -a\n```\n\n4. Push your changes to your forked repository.\n\n```\ngit push origin your-feature-or-bugfix-branch\n```\n\n5. Open a pull request in this repository and describe the changes you made.\n\nWe'll review your changes and work with you to get them merged into the main branch of the project.\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "Gordo core library",
"version": "0.3.6",
"project_urls": {
"Documentation": "https://gordo-core.readthedocs.io/",
"Homepage": "https://github.com/equinor/gordo-core",
"Repository": "https://github.com/equinor/gordo-core",
"Source": "https://github.com/equinor/gordo-core"
},
"split_keywords": [
"gordo-core"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bdb3a1f239307bcce7b4206249dcaa1dc14ff6ebf949760d2d1acca8a9b294c2",
"md5": "e3e183dca592ee4c5b59c811923461bf",
"sha256": "4c92e4bc16d6d8f27b403de7044eea59884ee6e2606c04f0a3a5bec6fa98272a"
},
"downloads": -1,
"filename": "gordo_core-0.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e3e183dca592ee4c5b59c811923461bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 64241,
"upload_time": "2024-07-04T10:30:46",
"upload_time_iso_8601": "2024-07-04T10:30:46.115002Z",
"url": "https://files.pythonhosted.org/packages/bd/b3/a1f239307bcce7b4206249dcaa1dc14ff6ebf949760d2d1acca8a9b294c2/gordo_core-0.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-04 10:30:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "equinor",
"github_project": "gordo-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gordo-core"
}
JSON
