Skip to main content

A client library for SCiMMA

Project description

SCiMMA Client

scimma-client is a pub-sub client library for Multimessenger Astrophysics.

Quickstart

Publish a GCN to Kafka:

scimma publish -b kafka://hostname:port/gcn mygcn.gcn3

An example RFC 822 formatted GCN circular (example.gcn3) is provided in tests/data.

Client configuration properties can be passed to scimma publish via -X property=value or in a configuration file specified by -F <config-file>, mimicking the behavior of kafkacat. This can be used to connect to a Kafka broker with SSL authentication enabled, for example.

Installation

You can install scimma-client either via pip, conda, or from source.

To install with pip:

pip install -U scimma-client

To install with conda, you must use the channel from the SCiMMA Anaconda organization:

conda install --channel scimma scimma-client

To install from source:

tar -xzf scimma-client-x.y.z.tar.gz
cd scimma-client-x.y.z
python setup.py install

Development

A Makefile is provided to ease in testing, deployment and generating documentation.

A list of commands can be listed with make help.

In addition, two extras are provided when installing the scimma client that installs the required test and documentation libraries:

pip install -U scimma-client[dev,docs]

To mark a new version, use Github tags to mark your commit with a semver version:

git tag v0.0.1

To release a new version and upload to package repositories, push your tag after pushing your commit:

git push --tags

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for scimma-client, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size scimma_client-0.0.4-py3-none-any.whl (6.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size scimma-client-0.0.4.tar.gz (18.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page