Skip to main content

datastreamcorelib

Core helpers and Abstract Base Classes for making use of ZMQ nice, easy and DRY.

You should probably look at https://gitlab.com/advian-oss/python-datastreamservicelib and https://gitlab.com/advian-oss/python-datastreamserviceapp_template unless you’re working on an adapter for yet unsupported eventloop.

Docker

For more controlled deployments and to get rid of “works on my computer” -syndrome, we always make sure our software works under docker.

It’s also a quick way to get started with a standard development environment.

SSH agent forwarding

We need buildkit:

export DOCKER_BUILDKIT=1

And also the exact way for forwarding agent to running instance is different on OSX:

export DOCKER_SSHAGENT="-v /run/host-services/ssh-auth.sock:/run/host-services/ssh-auth.sock -e SSH_AUTH_SOCK=/run/host-services/ssh-auth.sock"

and Linux:

export DOCKER_SSHAGENT="-v $SSH_AUTH_SOCK:$SSH_AUTH_SOCK -e SSH_AUTH_SOCK"

Creating a development container

Build image, create container and start it:

docker build --ssh default --target devel_shell -t datastreamcorelib:devel_shell .
docker create --name datastreamcorelib_devel -v `pwd`":/app" -it -v /tmp:/tmp `echo $DOCKER_SSHAGENT` datastreamcorelib:devel_shell
docker start -i datastreamcorelib_devel

pre-commit considerations

If working in Docker instead of native env you need to run the pre-commit checks in docker too:

docker exec -i datastreamcorelib_devel /bin/bash -c "pre-commit install --install-hooks"
docker exec -i datastreamcorelib_devel /bin/bash -c "pre-commit run --all-files"

You need to have the container running, see above. Or alternatively use the docker run syntax but using the running container is faster:

docker run -it --rm -v `pwd`":/app" datastreamcorelib:devel_shell -c "pre-commit run --all-files"

Test suite

You can use the devel shell to run py.test when doing development, for CI use the “tox” target in the Dockerfile:

docker build --ssh default --target tox -t datastreamcorelib:tox .
docker run -it --rm -v `pwd`":/app" `echo $DOCKER_SSHAGENT` datastreamcorelib:tox

Production docker

There’s a “production” target since it’s our standard pattern, however this library does not yet expose any CLI tools so the production target is kinda useless.

Local Development

TLDR:

  • Create and activate a Python 3.9 virtualenv (assuming virtualenvwrapper):

    mkvirtualenv -p `which python3.9` my_virtualenv
  • change to a branch:

    git checkout -b my_branch
  • install Poetry: https://python-poetry.org/docs/#installation

  • Install project deps and pre-commit hooks:

    poetry install
    pre-commit install --install-hooks
    pre-commit run --all-files
  • Ready to go.

Use Python 3.9 for development since it’s the lowest supported version so you don’t accidentally use features only available in higher versions and then have to re-do everything when CI tests fail on 3.9.

Remember to activate your virtualenv whenever working on the repo, this is needed because pylint and mypy pre-commit hooks use the “system” python for now (because reasons).

Running “pre-commit run –all-files” and “py.test -v” regularly during development and especially before committing will save you some headache.

Metadata

Release files for datastreamcorelib 1.7.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for datastreamcorelib 1.7.1
File Size Uploaded Provenance Actions
datastreamcorelib-1.7.1.tar.gz 13.6 kB Without provenance Details for datastreamcorelib-1.7.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for datastreamcorelib 1.7.1
File Interpreter ABI Platform Actions
datastreamcorelib-1.7.1-py3-none-any.whl Python 3 none any Details for datastreamcorelib-1.7.1-py3-none-any.whl

Total release size: 30.3 kB

Release files / datastreamcorelib-1.7.1.tar.gz

Download URL datastreamcorelib-1.7.1.tar.gz
Size 13.6 kB
Tags Source
SHA-256 checksum
How to use checksums
4d6579c8475890093ac9a33b40cedcebabfffbf2b1f25c14e03ba374dabc21b6
BLAKE2b-256 checksum
How to use checksums
20a76461146af8fda8ddcbd9a18c2bab11b0d2beb098d12c016c6000daded6a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / datastreamcorelib-1.7.1-py3-none-any.whl

Download URL datastreamcorelib-1.7.1-py3-none-any.whl
Size 16.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d8dbd8a1e89da7e2f109b9d8574f898c184550a9720ea23de21596dbdd434a6c
BLAKE2b-256 checksum
How to use checksums
949ab85a8f01cd064d6bd6b062c114f5a0510c87a1edad527286d6f6cb4827fa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Security for datastreamcorelib 1.7.1

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page