| Name | py-vibracore JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | Public python SDK for the CEMS VibraCore web-API. |
| upload_time | 2024-07-25 13:33:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2023 CEMS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
api
vibracore
cems
crux
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# py-vibracore
Public python SDK for the CEMS VibraCore web-API
[](http://mypy-lang.org/)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
This repository is created by [CEMS BV](https://cemsbv.nl/) and is a public
python wrapper around the CEMS
[VibraCore web-API](https://nuclei.cemsbv.io/#/vibracore/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](https://nuclei.cemsbv.io/#/). 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:
```bash
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:
```bash
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.
```bash
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:
```bash
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:
```bash
pip install pip-tools
```
Generate requirements.txt file with:
```bash
pip-compile --extra=test --extra=lint --extra=docs --extra=notebook --output-file=requirements.txt pyproject.toml
```
Update the requirements within the defined ranges with:
```bash
pip-compile --upgrade --extra=test --extra=lint --extra=docs --extra=notebook --output-file=requirements.txt pyproject.toml
```
Raw data
{
"_id": null,
"home_page": null,
"name": "py-vibracore",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "API, VibraCore, CEMS, CRUX",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/10/11/873602978488a89dd9c861aa8d2c45b147a21ea9eabd8728bed37aa80a56/py_vibracore-0.2.1.tar.gz",
"platform": null,
"description": "# py-vibracore\n\nPublic python SDK for the CEMS VibraCore web-API\n\n[](http://mypy-lang.org/)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n\nThis repository is created by [CEMS BV](https://cemsbv.nl/) and is a public\npython wrapper around the CEMS\n[VibraCore web-API](https://nuclei.cemsbv.io/#/vibracore/api).\n\n# Installation\n\nTo install a package in this repository run:\n\n`$ pip install py-vibracore`\n\n## ENV VARS\n\nTo use `py-vibracore` add the follow ENV vars to your environment. Or provide\nthem when asked.\n\n```\n* NUCLEI_TOKEN\n - Your NUCLEI user token\n```\n\nYou can obtain your `NUCLEI_TOKEN` on [NUCLEI](https://nuclei.cemsbv.io/#/). Go\nto `personal-access-tokens` and create a new user token.\n\n# Contribution\n\n## Environment\n\nWe recommend developing in Python3.9 with a clean virtual environment (using\n`virtualenv` or `conda`), installing the requirements from the requirements.txt\nfile:\n\nExample using `virtualenv` and `pip` to install the dependencies in a new\nenvironment .env on Linux:\n\n```bash\npython -m venv .env\nsource .env/bin/activate\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install -e .\n```\n\n## Documentation\n\nBuild the docs:\n\n```bash\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install .\n\nsphinx-build -b html docs public\n```\n\n## Format\n\nWe format our code with black and isort.\n\n```bash\nblack --config \"pyproject.toml\" src/pyvibracore tests notebooks\nisort --settings-path \"pyproject.toml\" src/pyvibracore tests notebooks\n```\n\n## Lint\n\nTo maintain code quality we use the GitHub super-linter.\n\nTo run the linters locally, run the `run_super_linters.sh` bash script from the\nroot directory.\n\n## UnitTest\n\nTest the software with the use of coverage:\n\n```bash\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install -e .\ncoverage run -m pytest\n```\n\n## Requirements\n\nRequirements are autogenerated by the `pip-compile` command with python 3.9\n\nInstall pip-tools with:\n\n```bash\npip install pip-tools\n```\n\nGenerate requirements.txt file with:\n\n```bash\npip-compile --extra=test --extra=lint --extra=docs --extra=notebook --output-file=requirements.txt pyproject.toml\n```\n\nUpdate the requirements within the defined ranges with:\n\n```bash\npip-compile --upgrade --extra=test --extra=lint --extra=docs --extra=notebook --output-file=requirements.txt pyproject.toml\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 CEMS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Public python SDK for the CEMS VibraCore web-API.",
"version": "0.2.1",
"project_urls": {
"repository": "https://github.com/cemsbv/py-vibracore"
},
"split_keywords": [
"api",
" vibracore",
" cems",
" crux"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8698e3fe8683b298fc31f0eb8a3e32ad0937dff428e1166c3be187d1b5f95015",
"md5": "e9806baf5c7fa7a69197047640b66da8",
"sha256": "5ac7c79434f1fe3785fe543a6c9dae02db2cafb66742a640f68702be4a99b6f2"
},
"downloads": -1,
"filename": "py_vibracore-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9806baf5c7fa7a69197047640b66da8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 25781,
"upload_time": "2024-07-25T13:33:06",
"upload_time_iso_8601": "2024-07-25T13:33:06.287740Z",
"url": "https://files.pythonhosted.org/packages/86/98/e3fe8683b298fc31f0eb8a3e32ad0937dff428e1166c3be187d1b5f95015/py_vibracore-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1011873602978488a89dd9c861aa8d2c45b147a21ea9eabd8728bed37aa80a56",
"md5": "d339b4af15653462f63f109e5f041eaf",
"sha256": "84e6ae94eda440b709abb3424d9a158ba9e7a17dd3bc928fdd2cf42b7917e062"
},
"downloads": -1,
"filename": "py_vibracore-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "d339b4af15653462f63f109e5f041eaf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 20438,
"upload_time": "2024-07-25T13:33:07",
"upload_time_iso_8601": "2024-07-25T13:33:07.697216Z",
"url": "https://files.pythonhosted.org/packages/10/11/873602978488a89dd9c861aa8d2c45b147a21ea9eabd8728bed37aa80a56/py_vibracore-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-25 13:33:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cemsbv",
"github_project": "py-vibracore",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "py-vibracore"
}
