Metadata-Version: 2.1
Name: chime-frb-api
Version: 2.6.0
Summary: CHIME/FRB API
Home-page: https://github.com/CHIMEFRB/frb-api
License: MIT
Author: Shiny Brar
Author-email: charanjotbrar@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: docs
Requires-Dist: attrs (>=22.2.0,<23.0.0)
Requires-Dist: click (>=7)
Requires-Dist: mkdocs-material (>=8) ; extra == "docs"
Requires-Dist: mkdocstrings-python[docs] (>=0.7.1,<0.8.0)
Requires-Dist: mkdocstrings[python] (>=0.18) ; extra == "docs"
Requires-Dist: pydantic (>=1.10.2,<2.0.0)
Requires-Dist: pyjwt (>=2,<3)
Requires-Dist: python-dateutil (>=2,<3)
Requires-Dist: pytkdocs[numpy-style] (>=0.10) ; extra == "docs"
Requires-Dist: requests (>=2,<3)
Requires-Dist: rich (>=13.1.0,<14.0.0)
Requires-Dist: tenacity (>=8.1.0,<9.0.0)
Project-URL: Documentation, https://github.com/CHIMEFRB/frb-api
Project-URL: Repository, https://github.com/CHIMEFRB/frb-api
Description-Content-Type: text/markdown

# CHIME/FRB API

|   **`Testing`**   | **`Coverage`**  |  **`Release`**  |   **`Style`**   |
|-----------------|-----------------|-----------------|-----------------|
| [![Continuous Integration](https://github.com/CHIMEFRB/frb-api/actions/workflows/ci.yml/badge.svg)](https://github.com/CHIMEFRB/frb-api/actions/workflows/ci.yml) | [![Coverage Status](https://coveralls.io/repos/github/CHIMEFRB/frb-api/badge.svg?t=uYdqsa)](https://coveralls.io/github/CHIMEFRB/frb-api) | [![PyPI version](https://img.shields.io/pypi/v/chime-frb-api.svg)](https://pypi.org/project/chime-frb-api/) | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://black.readthedocs.io/en/stable/)

--------

`chime-frb-api` is a python library to access CHIME/FRB backend. This library enables you interact with resources such as databases, event headers, calibration products, cluster jobs etc.

Check out the **[documentation](https://chimefrb.github.io/frb-api/)** for more details.

## Installation

The latest stable version is available on [PyPI](https://pypi.org/project/chime-frb-api/).
To install `chime-frb-api` simply run,

```bash
pip install --upgrade chime-frb-api
```

To add `chime-frb-api` to your project,

```bash
poetry add chime-frb-api
```

## Documentation

For further reading, please refer to the [documentation](https://chimefrb.github.io/frb-api/).

