Metadata-Version: 2.3
Name: tdemocracy
Version: 0.0.3
Summary: Listen to nuclear alerts from the Vera Rubin Observatory for the TDEmocracy project
Author: Jannis Necker
Author-email: necker@strw.leidenuniv.nl
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: dev
Provides-Extra: docs
Requires-Dist: autodoc-pydantic[erdantic] (>=2.2.0,<3.0.0) ; extra == "docs"
Requires-Dist: hop-client (>=0.12.1,<0.13.0)
Requires-Dist: mypy (>=1.5.1) ; extra == "dev"
Requires-Dist: pre-commit (>=3.4.0) ; extra == "dev"
Requires-Dist: py-avro-schema (>=3.8.2,<4.0.0)
Requires-Dist: pydantic (>=2.13.4,<3.0.0)
Requires-Dist: pydantic-settings (>=2.14.2,<3.0.0)
Requires-Dist: pytest (>=7.2) ; extra == "dev"
Requires-Dist: pytest-cov (>=4.0) ; extra == "dev"
Requires-Dist: sphinx (>=7.0) ; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints (>=1.25) ; extra == "docs"
Requires-Dist: sphinx-rtd-theme (>=3.1.0,<4.0.0) ; extra == "docs"
Requires-Dist: types-pyyaml (>=6.0.12.20260518,<7.0.0.0) ; extra == "dev"
Project-URL: Documentation, https://JannisNe.github.io/tdemocracy/
Project-URL: Repository, https://github.com/JannisNe/tdemocracy
Description-Content-Type: text/markdown

[![Release](https://img.shields.io/github/v/release/JannisNe/tdemocracy)](https://img.shields.io/github/v/release/JannisNe/tdemocracy)
[![Build status](https://img.shields.io/github/actions/workflow/status/JannisNe/tdemocracy/main.yml?branch=main)](https://github.com/JannisNe/tdemocracy/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/JannisNe/tdemocracy/branch/main/graph/badge.svg)](https://codecov.io/gh/JannisNe/tdemocracy)
[![Commit activity](https://img.shields.io/github/commit-activity/m/JannisNe/tdemocracy)](https://img.shields.io/github/commit-activity/m/JannisNe/tdemocracy)
[![License](https://img.shields.io/github/license/JannisNe/tdemocracy)](https://img.shields.io/github/license/JannisNe/tdemocracy)
[![Deploy Docs](https://github.com/JannisNe/tdemocracy/actions/workflows/deploy-docs.yml/badge.svg)](https://jannisne.github.io/tdemocracy)

# Listen to TDEmocracy!

This repository contains the data model used in the stream of candidate nuclear transients for the TDEmocracy project.

## Prerequisites

You need an account at the [SCIMMA Hopskotch service](https://scimma.org/hopskotch). Please contact the TDEmocracy lead to have your account added to the Ampel-TDEmocracy group. You can store your username and password in your environment variables `TDEMOCRACY_USERNAME` and `TDEMOCRACY_PASSWORD` or in a `.env` file in the root of the repository.

## Installation

Pull the repository and install the dependencies with [`poetry`](https://python-poetry.org/):

```bash
git clone https://github.com/JannisNe/tdemocracy.git
cd tdemocracy
poetry install
```

In the future, you will be able to install the package via `pip`:

```bash
pip install tdemocracy
```

## Usage:

```python
from tdemocracy.listen import listen_to_nuclear_stream

for report in listen_to_nuclear_stream():
    # do something with the report
    ...
```

Find more detailed documentation [here](https://jannisne.github.io/tdemocracy).

---

Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).

