https://github.com/chaostoolkit/chaostoolkit-extension-template
Template starting point for a new Python-based Chaos Toolkit extension
https://github.com/chaostoolkit/chaostoolkit-extension-template
chaos-engineering chaostoolkit
Last synced: 10 months ago
JSON representation
Template starting point for a new Python-based Chaos Toolkit extension
- Host: GitHub
- URL: https://github.com/chaostoolkit/chaostoolkit-extension-template
- Owner: chaostoolkit
- License: apache-2.0
- Created: 2017-12-11T10:14:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-27T21:01:09.000Z (almost 3 years ago)
- Last Synced: 2025-08-03T19:35:53.643Z (11 months ago)
- Topics: chaos-engineering, chaostoolkit
- Language: Python
- Homepage: https://chaostoolkit.org/
- Size: 85.9 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Chaos Toolkit Extension Template
[](https://img.shields.io/pypi/v/chaostoolkit-lib.svg)
[](https://img.shields.io/pypi/l/chaostoolkit-lib.svg)
[](https://github.com/chaostoolkit/chaostoolkit-extension-template/actions/workflows/build.yaml)
[](https://www.python.org/)
This project should be used as a starting point to create your own
Chaos Toolkit extension.
## Install
This package requires Python 3.7+
To be used from your experiment, this package must be installed in the Python
environment where [chaostoolkit][] already lives.
[chaostoolkit]: https://github.com/chaostoolkit/chaostoolkit
```
$ pip install chaostoolkit-
```
## Usage
That's it!
Please explore the code to see existing probes and actions.
## Configuration
## Test
To run the tests for the project execute the following:
```
$ pdm run test
```
### Formatting and Linting
We use a combination of [`black`][black], [`ruff`][ruff], and [`isort`][isort]
to both lint and format this repositories code.
[black]: https://github.com/psf/black
[ruff]: https://github.com/astral-sh/ruff
[isort]: https://github.com/PyCQA/isort
Before raising a Pull Request, we recommend you run formatting against your
code with:
```console
$ pdm run format
```
This will automatically format any code that doesn't adhere to the formatting
standards.
As some things are not picked up by the formatting, we also recommend you run:
```console
$ pdm run lint
```
To ensure that any unused import statements/strings that are too long, etc.
are also picked up.
## Contribute
If you wish to contribute more functions to this package, you are more than
welcome to do so. Please, fork this project, make your changes following the
usual [black][blackstyle] code style, sprinkling with tests and submit a PR for
review.
[blackstyle]: https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html
To contribute to this project, you will also need to install [pdm][].
[pdm]: https://pdm.fming.dev/latest/