Skip to content
Light-weight client to manipulate alerts from Fink
Jupyter Notebook Python CSS Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
assets
bin
datatest
db
fink_client
notebooks
schemas
tests
.coveragerc
.gitignore
.travis.yml
LICENSE
Procfile
README.md
app.py
requirements.txt
setup.py
sonar-project.properties

README.md

Quality Gate Status Maintainability Rating Build Status codecov Documentation Status

Fink client

fink-client is a light package to manipulate catalogs and alerts issued from the fink broker programmatically.

Installation

fink_client requires a version of Python 3.5+.

To install this module run the following commands:

# Install fink-client somewhere on your computer
git clone https://github.com/astrolabsoftware/fink-client
cd fink-client
pip install --upgrade pip setuptools wheel
pip install .

For testing purposes, update your ~/.bash_profile (assuming you are using bash shell) with the FINK_CLIENT_HOME environment variable:

echo "export FINK_CLIENT_HOME=${PWD}" >> ~/.bash_profile
source ~/.bash_profile
# and run the integration tests (docker-compose required)
fink_client_test.sh

If you don't see any error and all the test results are ok, you have installed it correctly.

Usage

Learn how to use fink-client by following the dedicated tutorial.

You can’t perform that action at this time.