gym-csle-cyborg
An OpenAI gym reinforcement learning environment API for the CybORG environment
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)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
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-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
Creative Commons
(C) 2020-2026, Kim Hammar
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gym_csle_cyborg-0.10.0.tar.gz.
File metadata
- Download URL: gym_csle_cyborg-0.10.0.tar.gz
- Upload date:
- Size: 61.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6dce9de35ea35edaedb3d41164d6f13be0ceeb2b47fbed307562645a4c96a33c
|
|
| MD5 |
b06fd538360f333b14799275993c37a7
|
|
| BLAKE2b-256 |
4ec1dee7323eb7b8595b4d60cd0a01678ce33e8bcc22428ab1a47dc4cc6497f2
|
File details
Details for the file gym_csle_cyborg-0.10.0-py3-none-any.whl.
File metadata
- Download URL: gym_csle_cyborg-0.10.0-py3-none-any.whl
- Upload date:
- Size: 52.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ecb8255101a9bb0a9fa5d0cdc7c3c332528f3b62199399d1a4021c9424a6a585
|
|
| MD5 |
d8c5f154b9ee34358e03637a6ee35b98
|
|
| BLAKE2b-256 |
2fe07eeb73a7f57835e8d49859771e5a570fa079b2b510d8b316eaf9a75bb5af
|
