Metadata-Version: 2.1
Name: sdss-cerebro
Version: 0.1.1
Summary: Telemetry management and time series for SDSS-V
Home-page: https://github.com/sdss/cerebro
License: BSD-3-Clause
Keywords: astronomy,software
Author: José Sánchez-Gallego
Author-email: gallegoj@uw.edu
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: click (>=8.0.0,<9.0.0)
Requires-Dist: click-default-group (>=1.2.2,<2.0.0)
Requires-Dist: daemonocle (>=1.0.2,<2.0.0)
Requires-Dist: influxdb-client (>=1.9.0,<2.0.0)
Requires-Dist: ntplib (>=0.3.4,<0.4.0)
Requires-Dist: numpy (>=1.17.4,<2.0.0)
Requires-Dist: sdss-clu (>=1.0.0,<2.0.0)
Requires-Dist: sdss-drift (>=0.2.2,<0.3.0)
Requires-Dist: sdsstools (>=0.4.0)
Project-URL: Documentation, https://sdss-cerebro.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/sdss/cerebro
Description-Content-Type: text/markdown

# cerebro

![Versions](https://img.shields.io/badge/python->3.7-blue)
[![Documentation Status](https://readthedocs.org/projects/sdss-cerebro/badge/?version=latest)](https://sdss-cerebro.readthedocs.io/en/latest/?badge=latest)
[![Test Status](https://github.com/albireox/cerebro/workflows/Test/badge.svg)](https://github.com/sdss/sdss/actions)
[![codecov](https://codecov.io/gh/sdss/cerebro/branch/main/graph/badge.svg)](https://codecov.io/gh/sdss/cerebro)

A library to gather time-series data from different subsystems and store them in an InfluxDB server.

## Installation

In general you should be able to install ``cerebro`` by doing

```console
pip install sdss-cerebro
```

To build from source, use

```console
git clone git@github.com:sdss/cerebro
cd cerebro
pip install .
```

## Development

`cerebro` uses [poetry](http://poetry.eustace.io/) for dependency management and packaging. To work with an editable install it's recommended that you setup `poetry` and install `cerebro` in a virtual environment by doing

```console
poetry install
```

Pip does not support editable installs with PEP-517 yet. That means that running `pip install -e .` will fail because `poetry` doesn't use a `setup.py` file. As a workaround, you can use the `create_setup.py` file to generate a temporary `setup.py` file. To install `cerebro` in editable mode without `poetry`, do

```console
pip install poetry
python create_setup.py
pip install -e .
```

