Skip to content

Commit

Permalink
style: format markdown and bash file
Browse files Browse the repository at this point in the history
  • Loading branch information
RDWimmers committed Feb 13, 2024
1 parent ebeb941 commit 17e2220
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 25 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,44 @@
# py-vibracore

Public python SDK for the CEMS VibraCore web-API

[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](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).
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.
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.
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:
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:
Example using `virtualenv` and `pip` to install the dependencies in a new
environment .env on Linux:

```bash
python -m venv .env
Expand Down Expand Up @@ -68,7 +73,8 @@ isort --settings-path "pyproject.toml" src/pyvibracore tests notebooks

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.
To run the linters locally, run the `run_super_linters.sh` bash script from the
root directory.

## UnitTest

Expand Down Expand Up @@ -101,4 +107,4 @@ 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
```
```
30 changes: 15 additions & 15 deletions run_super_linter.sh
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
#!/bin/bash

docker run \
--env VALIDATE_ALL_CODEBASE=false \
--env RUN_LOCAL=true \
--env VALIDATE_JSCPD=false \
--env VALIDATE_CSS=false \
--env VALIDATE_BASH=false \
--env VALIDATE_YAML=false \
--env VALIDATE_PYTHON_PYLINT=false \
--env VALIDATE_NATURAL_LANGUAGE=false \
--env VALIDATE_MARKDOWN=false \
--env LINTER_RULES_PATH=/ \
--env PYTHON_BLACK_CONFIG_FILE=pyproject.toml \
--env PYTHON_ISORT_CONFIG_FILE=pyproject.toml \
--env PYTHON_MYPY_CONFIG_FILE=pyproject.toml \
--env PYTHON_FLAKE8_CONFIG_FILE=.flake8 \
-v $(pwd):/tmp/lint github/super-linter:v5
--env VALIDATE_ALL_CODEBASE=false \
--env RUN_LOCAL=true \
--env VALIDATE_JSCPD=false \
--env VALIDATE_CSS=false \
--env VALIDATE_BASH=false \
--env VALIDATE_YAML=false \
--env VALIDATE_PYTHON_PYLINT=false \
--env VALIDATE_NATURAL_LANGUAGE=false \
--env VALIDATE_MARKDOWN=false \
--env LINTER_RULES_PATH=/ \
--env PYTHON_BLACK_CONFIG_FILE=pyproject.toml \
--env PYTHON_ISORT_CONFIG_FILE=pyproject.toml \
--env PYTHON_MYPY_CONFIG_FILE=pyproject.toml \
--env PYTHON_FLAKE8_CONFIG_FILE=.flake8 \
-v $(pwd):/tmp/lint github/super-linter:v5

0 comments on commit 17e2220

Please sign in to comment.