NUCLEI

This repository is created by CEMS BV and helps the user to access and process API calls to the NUCLEI environment.

Installation

To install a package in this repository run:

$ pip install cems-nuclei

Please note that to use GeoDataFrames from the geopandas library cems-nuclei[geo] should be installed.

ENV VARS

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

* NUCLEI_USER
    - Your NUCLEI user name
* NUCLEI_PASSWORD
    - Your NUCLEI user password

Code quality tools

To maintain code quality we use super-linter.

docker pull github/super-linter:latest
docker run -e RUN_LOCAL=true \
-e VALIDATE_PYTHON_PYLINT=false \
-e VALIDATE_MARKDOWN=false \
-e VALIDATE_JSCPD=false \
-e VALIDATE_CSS=false \
-e VALIDATE_YAML=false \
-e VALIDATE_PYTHON_FLAKE8=false \
-v $PWD:/tmp/lint github/super-linter

Documentation

Install the requirements:

pip install -r docs.requirements.txt

Build the docs:

sphinx-build -b html docs public