Metadata-Version: 2.4
Name: pyipses
Version: 0.0.5
Summary: PYIPSES library.
Author-email: Christian Biasuzzi <christian.biasuzzi@soft.it>, Massimo Ferraro <massimo.ferraro@soft.it>
License-Expression: GPL-3.0
License-File: LICENSE
Requires-Python: >=3.8
Requires-Dist: ipyleaflet
Requires-Dist: ipywidgets
Requires-Dist: pandas
Requires-Dist: plotly-express
Description-Content-Type: text/markdown

# PYIPSES

Python library for [IPSES](https://www.ipses-ri.it/index.php/it)

PYIPSES provides an API to connect with IPSES (e.g., to retrieve the user's workspace data).

The main Target of the API is the [Jupyter](https://jupyter.org) notebooks.

## Build from sources

Create a virtual environment and install PYIPSES in *editable* mode with the optional development dependencies:

```sh
python -m venv .venv
source .venv/bin/activate

pip install --upgrade setuptools pip
pip install -r requirements.txt

pip install -e .
```

Please note that pip only supports editable installs (enabled with the option -e) from a pyproject.toml files since v21.3.

Make sure you have an up-to-date version of pip

```sh
pip install --upgrade pip
```

To run unit tests:

```bash
pytest tests
```


To run linting inspection with `pylint`:
```bash
pylint pyipses
```


## Packaging for distribution

To package PYIPSES in a .whl file, for distribution:

```bash
python -m build --wheel
```

The 'created .whl file' will be available in the 'dist' directory. To install the .whl file:

```bash
pip install <'path to the created .whl file'>
```


## Packaging for distribution using docker compose

To package PYIPSES in a .whl file, for distribution, using docker:

```bash
docker compose -f builder-docker-compose.yml run --rm build_wheel
```

