Skip to content

Commit 1b38f8a

Browse files
committed
fix readme
Signed-off-by: Sylvain Hellegouarch <sh@defuze.org>
1 parent 885f462 commit 1b38f8a

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# Chaos Toolkit Extension Template
1+
# Chaos Toolkit Extension For Datadog
22

33
[![Version](https://img.shields.io/pypi/v/chaostoolkit-datadog.svg)](https://img.shields.io/pypi/v/chaostoolkit-datadog.svg)
44
[![License](https://img.shields.io/pypi/l/chaostoolkit-datadog.svg)](https://img.shields.io/pypi/l/chaostoolkit-datadog.svg)
55

6-
[![Build, Test, and Lint](https://github.com/chaostoolkit-incubator/chaostoolkit-datadog/actions/workflows/build.yaml/badge.svg)](https://github.com/chaostoolkit-incubator/chaostoolkit-datadog/actions/workflows/build.yaml)
6+
[![Build](https://github.com/chaostoolkit-incubator/chaostoolkit-datadog/actions/workflows/build.yaml/badge.svg)](https://github.com/chaostoolkit-incubator/chaostoolkit-datadog/actions/workflows/build.yaml)
77
[![Python versions](https://img.shields.io/pypi/pyversions/chaostoolkit-datadog.svg)](https://www.python.org/)
88

99
This project contains Chaos Toolkit activities and tolerances to work
1010
with DataDog.
1111

1212
## Install
1313

14-
This package requires Python 3.7+
14+
This package requires Python 3.8+
1515

1616
To be used from your experiment, this package must be installed in the Python
1717
environment where [chaostoolkit][] already lives.
@@ -93,23 +93,20 @@ notably:
9393
To run the tests for the project execute the following:
9494

9595
```
96-
$ pytest
96+
$ pdm run test
9797
```
9898

9999
### Formatting and Linting
100100

101-
We use a combination of [`black`][black], [`flake8`][flake8], and [`isort`][isort]
102-
to both lint and format this repositories code.
101+
We use [`ruff`][ruff] to both lint and format this repositories code.
103102

104-
[black]: https://github.com/psf/black
105-
[flake8]: https://github.com/PyCQA/flake8
106-
[isort]: https://github.com/PyCQA/isort
103+
[ruff]: https://github.com/astral-sh/ruff
107104

108105
Before raising a Pull Request, we recommend you run formatting against your
109106
code with:
110107

111108
```console
112-
$ make format
109+
$ pdm run format
113110
```
114111

115112
This will automatically format any code that doesn't adhere to the formatting
@@ -118,7 +115,7 @@ standards.
118115
As some things are not picked up by the formatting, we also recommend you run:
119116

120117
```console
121-
$ make lint
118+
$ pdm run lint
122119
```
123120

124121
To ensure that any unused import statements/strings that are too long, etc.
@@ -131,4 +128,4 @@ welcome to do so. Please, fork this project, make your changes following the
131128
usual [PEP 8][pep8] code style, sprinkling with tests and submit a PR for
132129
review.
133130

134-
[pep8]: https://pycodestyle.readthedocs.io/en/latest/
131+
[pep8]: https://peps.python.org/pep-0008/

0 commit comments

Comments
 (0)