Public python SDK for the CEMS VibraCore web-API.
Project description
py-vibracore
Public python SDK for the CEMS VibraCore web-API
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for py_vibracore-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ac7c79434f1fe3785fe543a6c9dae02db2cafb66742a640f68702be4a99b6f2 |
|
MD5 | e9806baf5c7fa7a69197047640b66da8 |
|
BLAKE2b-256 | 8698e3fe8683b298fc31f0eb8a3e32ad0937dff428e1166c3be187d1b5f95015 |