`csle-base`

A library with base classes and definitions for CSLE Python libraries.

PyPI - Downloads

Requirements

Python 3.8+

Development Requirements

Python 3.8+
flake8 (for linting)
flake8-rst-docstrings (for linting docstrings)
tox (for automated testing)
pytest (for unit tests)
pytest-cov (for unit test coverage)
mypy (for static typing)
mypy-extensions (for static typing)
mypy-protobuf (for static typing)
types-PyYaml (for static typing)
types-paramiko (for static typing)
types-protobuf (for static typing)
types-requests (for static typing)
types-urllib3 (for static typing)
sphinx (for API documentation)
sphinxcontrib-napoleon (for API documentation)
sphinx-rtd-theme (for API documentation)
pytest-mock (for mocking tests)
pytest-grpc (for grpc tests)

Installation

# install from pip
pip install csle-base==<version>
# local install from source
$ pip install -e csle-base
# or (equivalently):
make install
# force upgrade deps
$ pip install -e csle-base --upgrade
# git clone and install from source
git clone https://github.com/Kim-Hammar/csle
cd csle/simulation-system/libs/csle-base
pip3 install -e .
# Install development dependencies
$ pip install -r requirements_dev.txt

Development tools

Install all development tools at once:

make install_dev

pip install -r requirements_dev.txt

API documentation

This section contains instructions for generating API documentation using sphinx.

Latest Documentation

The latest documentation is available at https://kim-hammar.github.io/csle//docs/csle-base

Generate API Documentation

First make sure that the CSLE_HOME environment variable is set:

echo $CSLE_HOME

Then generate the documentation with the commands:

cd docs
sphinx-apidoc -f -o source/ ../src/csle_base/
make html

To update the official documentation at https://kim-hammar.github.io/csle/, copy the generated HTML files to the documentation folder:

cp -r build/html ../../../../docs/_docs/csle-base

To run all documentation commands at once, use the command:

make docs

Static code analysis

To run the Python linter, execute the following command:

flake8 .
# or (equivalently):
make lint

To run the mypy type checker, execute the following command:

mypy .
# or (equivalently):
make types

Unit tests

To run the unit tests, execute the following command:

pytest
# or (equivalently):
make unit_tests

To run tests of a specific test suite, execute the following command:

pytest -k "ClassName"

To generate a coverage report, execute the following command:

pytest --cov=csle_base

Run tests and code analysis in different python environments

To run tests and code analysis in different python environments, execute the following command:

tox
# or (equivalently):
make tests

Create a new release and publish to PyPi

First build the package by executing:

python3 -m build
# or (equivalently)
make build

After running the command above, the built package is available at ./dist.

Push the built package to PyPi by running:

python3 -m twine upload dist/*
# or (equivalently)
make push

To run all commands for the release at once, execute:

make release

Author & Maintainer

Kim Hammar kimham@kth.se

Copyright and license

LICENSE

Creative Commons

Metadata

Release files for csle-base 0.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for csle-base 0.10.1
File	Size	Uploaded
csle_base-0.10.1.tar.gz	23.3 kB	Sep 14, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for csle-base 0.10.1
File	Interpreter	ABI	Platform	Reset
csle_base-0.10.1-py3-none-any.whl 11.2 kB Sep 14, 2026	Python 3	none	any	Details

Total release size: 34.5 kB

Release files / csle_base-0.10.1.tar.gz

Download URL	csle_base-0.10.1.tar.gz
Size	23.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`1e5f6e045fee0e0232823abb4844173b40424a988a8a991a30529eeb1e4a2539`
BLAKE2b-256 checksum How to use checksums	`4d2d7e5b6ded8ef351bca71c9a88f8a09581ecbc2393e76ff29dfe907d4d57bb`
Upload date	Sep 14, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.11.11`

Release files / csle_base-0.10.1-py3-none-any.whl

Download URL	csle_base-0.10.1-py3-none-any.whl
Size	11.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c727572eb97cd32ea1e551985a084ebb9729a15991842536ff060cc9437859ae`
BLAKE2b-256 checksum How to use checksums	`0b49cd8c834befa79eae45b7e0cc7d952ce42b92bdfd02283e41beccc898a012`
Upload date	Sep 14, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.11.11`