`gym-csle-cyborg`

An OpenAI gym reinforcement learning environment API for the CybORG environment

PyPI - Downloads

Requirements

Python 3.8+
csle-base
csle-common
csle-attacker
csle-defender
csle-collector
gymnasium for specifying the RL environment API

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)
pytest-mock (for mocking tests)
pytest-grpc (for grpc tests)
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)

Installation

# install from pip
pip install gym-csle-cyborg==<version>
# local install from source
$ pip install -e gym-csle-cyborg
# or (equivalently):
make install
# force upgrade deps
$ pip install -e gym-csle-cyborg --upgrade
# git clone and install from source
git clone https://github.com/Kim-Hammar/csle
cd csle/simulation-system/libs/gym-csle-cyborg
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/gym-csle-cyborg

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/gym_csle_cyborg/
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/gym-csle-cyborg

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=gym_csle_cyborg

Run tests and code analysis in different python environments

To run tests and code analysis in different python environemnts, 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

Release files for gym-csle-cyborg 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 gym-csle-cyborg 0.10.1
File	Size	Uploaded
gym_csle_cyborg-0.10.1.tar.gz	61.6 kB	Sep 14, 2026	Details

Built distribution (wheel)

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

Total release size: 114.2 kB

Release files / gym_csle_cyborg-0.10.1.tar.gz

Download URL	gym_csle_cyborg-0.10.1.tar.gz
Size	61.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`d86dc5250ce9a4f73d890080656140cfc13924dbc3594270bc338ffabde6dd34`
BLAKE2b-256 checksum How to use checksums	`0f5a83ed9960fe25abe60cb8400ce60fa0b8d49301d1bbb948d6f859c012bcd3`
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 / gym_csle_cyborg-0.10.1-py3-none-any.whl

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