Installation

chime-frb-api is avalaible directly from PyPI

pippoetry

Text Only

pip install --upgrade chime-frb-api

Text Only

poetry add chime-frb-api

Alternatively, in order to install the bleeding edge version directly from Github

pippoetry

Text Only

pip install git+https://github.com/CHIMEFRB/frb-api.git

Text Only

poetry add git+https://github.com/CHIMEFRB/frb-api.git

Finally in order to develop and experiment with the source code, you can also clone the github repository and edit your local copy.

Bash

git clone https://github.com/CHIMEFRB/frb-api.git
cd frb-api
pip install .

Dependencies

• Python 3.6+

Mandatory

• requests
• pyjwt
• python-dateutil

Developer

• pytest
• pytest-cov
• coverage
• pyyaml

Documenation

• mkdocs-material

Bugs

Please report any bugs you encounter through the github issue tracker. It will be most helpful to include a reproducible example of the issue with information on expected and actual behavior.

It is difficult to debug any issues without knowing the versions of chime-frb-api and the backend version you are connected to. These can be found through:

Python

from chime_frb_api import __version__
from chime_frb_api.backends import frb_master

master = frb_master.FRBMaster()
print("Backend Version: {}".format(master.version()))
print("API Version: {}".format(__version__))

Developer Resources

To contribute to the code base, visit the developer guidelines.