Skip to main content

py-vibracore

Public python SDK for the CEMS VibraCore web-API

Checked with mypy Code style: black Imports: isort

This repository is created by CEMS BV and is a public python wrapper around the CEMS VibraCore web-API.

Installation

To install a package in this repository run:

$ pip install py-vibracore

ENV VARS

To use py-vibracore add the follow ENV vars to your environment. Or provide them when asked.

* NUCLEI_TOKEN
    - Your NUCLEI user token

You can obtain your NUCLEI_TOKEN on NUCLEI. Go to personal-access-tokens and create a new user token.

Contribution

Environment

We recommend developing in Python3.9 with a clean virtual environment (using virtualenv or conda), installing the requirements from the requirements.txt file:

Example using virtualenv and pip to install the dependencies in a new environment .env on Linux:

python -m venv .env
source .env/bin/activate
python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install -e .

Documentation

Build the docs:

python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install .

sphinx-build -b html docs public

Format

We format our code with black and isort.

black --config "pyproject.toml" src/pyvibracore tests notebooks
isort --settings-path "pyproject.toml" src/pyvibracore tests notebooks

Lint

To maintain code quality we use the GitHub super-linter.

To run the linters locally, run the run_super_linters.sh bash script from the root directory.

UnitTest

Test the software with the use of coverage:

python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install -e .
coverage run -m pytest

Requirements

Requirements are autogenerated by the pip-compile command with python 3.9

Install pip-tools with:

pip install pip-tools

Generate requirements.txt file with:

pip-compile --extra=test --extra=lint --extra=docs --extra=notebook --output-file=requirements.txt pyproject.toml

Update the requirements within the defined ranges with:

pip-compile --upgrade --extra=test --extra=lint --extra=docs --extra=notebook --output-file=requirements.txt pyproject.toml

Download files

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

Source Distribution

py_vibracore-0.3.2.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_vibracore-0.3.2-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

Details for the file py_vibracore-0.3.2.tar.gz.

File metadata

  • Download URL: py_vibracore-0.3.2.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for py_vibracore-0.3.2.tar.gz
Algorithm Hash digest
SHA256 b8ca891da6c8143bd0b75a549201e8fbeefea48c55141e6772fb021bc6b0bcad
MD5 cf1538af4397514e51f9f82a1c2ee993
BLAKE2b-256 65004c0e1d61b77c0ae9a98e0d0bf965573c5c136e4a3bee0edcc5f9bd744fbd

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_vibracore-0.3.2.tar.gz:

Publisher: release_pypi.yaml on cemsbv/py-vibracore

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file py_vibracore-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: py_vibracore-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 25.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for py_vibracore-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 740408218997c4779efe155b8b6b1c811514d2dc3990b791dd09f8171ac93eee
MD5 c67033bf25673e5e92059b876152f833
BLAKE2b-256 cadd78318dd52afb80a42efd061715dbd063d5d6345c2606f85b3473e12f88e2

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_vibracore-0.3.2-py3-none-any.whl:

Publisher: release_pypi.yaml on cemsbv/py-vibracore

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.2 This release

2 files

0.3.1

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.1

2 files

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