| Docs: | https://hop-client.readthedocs.io/en/stable/ |
hop-client is a pub-sub client library for Multimessenger Astrophysics.
You can install hop either via pip, conda, or from source.
To install with pip:
pip install -U hop-client
To install with conda:
conda install -c conda-forge hop-client
To install from source:
tar -xzf hop-client-x.y.z.tar.gz
cd hop-client-x.y.z
python setup.py install
By default, authentication is enabled, reading in configuration settings
from config.toml. The path to this configuration can be found by running
hop auth locate. One can initialize this configuration with default
settings by running hop auth setup. To disable authentication in the CLI
client, one can run --no-auth.
Publish a message:
hop publish kafka://hostname:port/gcn -f CIRCULAR example.gcn3
Example messages are provided in tests/data including:
- A GCN circular (
example.gcn3) - A VOEvent (
example_voevent.xml)
Consume messages:
hop subscribe kafka://hostname:port/gcn -s EARLIEST
This will read messages from the gcn topic from the earliest offset and read messages until an end of stream (EOS) is received.
Publish messages:
Using the python API, we can publish various types of messages, including structured messages such as GCN Circulars and VOEvents:
from hop import stream
from hop.models import GCNCircular
# read in a GCN circular
with open("path/to/circular.gcn3", "r") as f:
circular = GCNCircular.load(f)
with stream.open("kafka://hostname:port/topic", "w") as s:
s.write(circular)In addition, we can also publish unstructured messages as long as they are JSON serializable:
from hop import stream
with stream.open("kafka://hostname:port/topic", "w") as s:
s.write({"my": "message"})By default, authentication is enabled for the Hop broker, reading in configuration
settings from config.toml. In order to modify various authentication options, one
can configure a Stream instance and pass in an Auth instance with credentials:
from hop import Stream
from hop.auth import Auth
auth = Auth("my-username", "my-password")
stream = Stream(auth=auth)
with stream.open("kafka://hostname:port/topic", "w") as s:
s.write({"my": "message"})To explicitly disable authentication one can set auth to False.
Consume messages:
from hop import stream
with stream.open("kafka://hostname:port/topic", "r") as s:
for message in s:
print(message)This will listen to the Hop broker, listening to new messages and printing them to
stdout as they arrive until there are no more messages in the stream.
By default, this will only process new messages since the connection was opened.
The start_at option lets you control where in the stream you can start listening
from. For example, if you'd like to listen to all messages stored in a topic, you can do:
from hop import Stream
from hop.io import StartPosition
stream = Stream(start_at=StartPosition.EARLIEST)
with stream.open("kafka://hostname:port/topic", "r") as s:
for message in s:
print(message)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 hop client that installs the required test and documentation libraries:
- dev: dependencies required for testing, linting and packaging
- docs: dependencies required for building documentation
Assuming you've cloned the repository and are in the project's root directory, you can install hop-client alongside all the required development dependencies by running:
pip install .[dev,docs]
To create a new release, first make a Github Issue for the specific release using the release template. Complete the steps in the Pre-release section; once that section is finished, complete the Release section. Ensure that the new version release string follows the semver conventions, e.g., v0.0.1.
These steps will result in a new Github release, as well as a new package version uploaded to PyPI and conda-forge via Github Actions.