Hop Client
hop-client is a pub-sub client library for Multimessenger Astrophysics.
Quickstart
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.
Installation
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 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 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
Metadata
Release files for hop-client 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hop-client-0.0.5.tar.gz | 25.8 kB | Without provenance | Details for hop-client-0.0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hop_client-0.0.5-py3-none-any.whl | Python 3 | none | any | Details for hop_client-0.0.5-py3-none-any.whl |
Total release size: 34.8 kB
Release files / hop-client-0.0.5.tar.gz
| Download URL | hop-client-0.0.5.tar.gz |
|---|---|
| Size | 25.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
11bc5950b4cfc2d82581dbdb1abe5d27ecc0f75c1782eac5fbe0aa570a65f2ed
|
|
BLAKE2b-256 checksum How to use checksums |
14a113acb66ef8f7266d20bca48badc816c3d8c7638ac28f94d50063f9dafef2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10
|
Release files / hop_client-0.0.5-py3-none-any.whl
| Download URL | hop_client-0.0.5-py3-none-any.whl |
|---|---|
| Size | 9.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d647c71d20bc5cdae774f6fae004e1cf3fad7f980a45e7d979862d4304f98a46
|
|
BLAKE2b-256 checksum How to use checksums |
860b270e47732cf431c47077e1335c7104b6bc0ca5f572cc72251a2691920d14
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10
|
Security for hop-client 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.