Skip to main content

A pub-sub client library for Multi-messenger Astrophysics

Project description

Hop Client

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


Publish a GCN to Kafka:

hop publish kafka://hostname:port/gcn mygcn.gcn3

Subscribe to the earliest offset of a Kafka topic and print to stdout:

hop subscribe kafka://hostname:port/gcn -e

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

Client configuration properties can be passed to hop 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.


You can install hop either via pip, conda, or from source.

To install with pip:

pip install -U hop-client

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

conda install --channel scimma hop-client

To install from source:

tar -xzf hop-client-x.y.z.tar.gz
cd hop-client-x.y.z
python install


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 hop-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.

Source Distribution

hop-client-0.0.5a1.tar.gz (24.9 kB view hashes)

Uploaded Source

Built Distribution

hop_client-0.0.5a1-py3-none-any.whl (8.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page