gym-csle-intrusion-response-game
An OpenAI gym reinforcement learning environment that represents an intrusion response game
Requirements
- Python 3.8+
csle-basecsle-commoncsle-attackercsle-defendercsle-collectorgymnasiumfor 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)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)pytest-mock(for mocking tests)pytest-grpc(for grpc tests)sphinxcontrib-napoleon(for API documentation)sphinx-rtd-theme(for API documentation)
Installation
# install from pip
pip install gym-csle-intrusion-response-game==<version>
# local install from source
$ pip install -e gym-csle-intrusion-response-game
# or (equivalently):
make install
# force upgrade deps
$ pip install -e gym-csle-intrusion-response-game --upgrade
# git clone and install from source
git clone https://github.com/Kim-Hammar/csle
cd csle/simulation-system/libs/gym-csle-intrusion-response-game
pip3 install -e .
# Install development dependencies
$ pip install -r requirements_dev.txt
Development tools
Install all development tools at once:
make install_dev
or
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-intrusin-response-game
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_intrusion_response_game/
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-intrusion-response-game
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_intrusion_response_game
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
Creative Commons
(C) 2020-2026, Kim Hammar
1 maintainer
Metadata
1 maintainer
Release files for gym-csle-intrusion-response-game 0.10.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gym_csle_intrusion_response_game-0.10.1.tar.gz | 47.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gym_csle_intrusion_response_game-0.10.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 96.6 kB
Release files / gym_csle_intrusion_response_game-0.10.1.tar.gz
| Download URL | gym_csle_intrusion_response_game-0.10.1.tar.gz |
|---|---|
| Size | 47.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9dad1815e97db6fefcd114b75479804552ad6bf41cbc36fa0acb12364d3aab77
|
|
BLAKE2b-256 checksum How to use checksums |
466f8dc9182a612365b4e65e15fe6d4569c0bd963f5bd3b6db1004f1fc7521f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
Release files / gym_csle_intrusion_response_game-0.10.1-py3-none-any.whl
| Download URL | gym_csle_intrusion_response_game-0.10.1-py3-none-any.whl |
|---|---|
| Size | 49.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
556a917b4f03fac1213e380bc72c3046d2b84f7492096e325cf49dfbb7c52c72
|
|
BLAKE2b-256 checksum How to use checksums |
c74793c5c72ebda21431b3689105aaeadd2bc1f9b4d4af755cac10d59a55c240
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
