Metadata-Version: 2.1
Name: gordo-core
Version: 0.3.6
Summary: Gordo core library
Home-page: https://github.com/equinor/gordo-core
License: AGPLv3
Keywords: gordo-core
Author: Equinor ASA
Author-email: fg_gpl@equinor.com
Requires-Python: >=3.9,<4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Dist: cachetools (>=5.3.0,<6.0.0)
Requires-Dist: influxdb (>=5.3.0,<6.0.0)
Requires-Dist: numexpr (>=2.7.1,<3.0.0)
Requires-Dist: numpy (>=1.18.0,<2.0.0,!=1.20)
Requires-Dist: pandas (>=1.1.0,<2.0.0)
Requires-Dist: pyarrow (>=14.0.1,<15.0.0)
Requires-Dist: scikit-learn (>=1.2.2,<2.0.0)
Requires-Dist: scipy; python_version < "3.12"
Requires-Dist: xarray (>=0.16.2,<2024.0.0)
Project-URL: Documentation, https://gordo-core.readthedocs.io/
Project-URL: Repository, https://github.com/equinor/gordo-core
Project-URL: Source, https://github.com/equinor/gordo-core
Description-Content-Type: text/markdown

[![SCM Compliance](https://scm-compliance-api.radix.equinor.com/repos/equinor/805e1799-b38a-48b5-a04f-2dff17ee744a/badge)](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.
