Metadata-Version: 2.1
Name: py-pilecore
Version: 0.3.2
Summary: Public python SDK for the CEMS PileCore web-API.
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.
        
Project-URL: repository, https://github.com/cemsbv/py-pilecore
Keywords: API,PileCore,CEMS,CRUX
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pygef<1,>0.8
Requires-Dist: numpy<2,>1
Requires-Dist: pandas<3,>2
Requires-Dist: cems-nuclei[client]<1,>=0.5
Requires-Dist: matplotlib<4,>=3.8
Requires-Dist: tqdm[notebook]<5,>4
Requires-Dist: natsort<9,>8
Requires-Dist: shapely<3,>=2
Provides-Extra: test
Requires-Dist: coveralls; extra == "test"
Requires-Dist: pytest; extra == "test"
Provides-Extra: docs
Requires-Dist: Sphinx==6.1.3; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints==1.22; extra == "docs"
Requires-Dist: ipython==8.11.0; extra == "docs"
Requires-Dist: asteroid-sphinx-theme==0.0.3; extra == "docs"
Requires-Dist: sphinx_rtd_theme==1.2.0; extra == "docs"
Provides-Extra: lint
Requires-Dist: mypy==1.6.1; extra == "lint"
Requires-Dist: mypy-extensions==1.0.0; extra == "lint"
Requires-Dist: tomli==2.0.1; extra == "lint"
Requires-Dist: typing_extensions==4.7.1; extra == "lint"
Requires-Dist: black[jupyter]==23.10.1; extra == "lint"
Requires-Dist: click==8.1.3; extra == "lint"
Requires-Dist: packaging==23.2; extra == "lint"
Requires-Dist: pathspec==0.11.1; extra == "lint"
Requires-Dist: platformdirs==3.5.1; extra == "lint"
Requires-Dist: tomli==2.0.1; extra == "lint"
Requires-Dist: isort==5.12.0; extra == "lint"
Requires-Dist: flake8==6.0.0; extra == "lint"
Requires-Dist: mccabe==0.7.0; extra == "lint"
Requires-Dist: pycodestyle==2.10.0; extra == "lint"
Requires-Dist: pyflakes==3.0.1; extra == "lint"
Requires-Dist: pandas-stubs<3,>2; extra == "lint"
Requires-Dist: types-tqdm<5,>4; extra == "lint"

# py-pilecore
Public python SDK for the CEMS PileCore 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/)
[![Coverage Status](https://coveralls.io/repos/github/cemsbv/py-pilecore/badge.svg)](https://coveralls.io/github/cemsbv/py-pilecore)


This repository is created by [CEMS BV](https://cemsbv.nl/) and is a public python wrapper around the CEMS [PileCore web-API](https://nuclei.cemsbv.io/#/pilecore/api).

# Installation

To install a package in this repository run:

`$ pip install py-pilecore`


## ENV VARS

To use `py-pilecore` 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.10 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/pypilecore tests notebooks
isort --settings-path "pyproject.toml" src/pypilecore 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.10

Install pip-tools with:

```bash
pip install pip-tools
```

Generate requirements.txt file with:

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

Update the requirements within the defined ranges with:

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