aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Python.md
blob: 51d4bd650f1cd2136e7df61c6aabbd0d3a32a656 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# locusts-r-us

[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/python.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/python.yml)
![PyPI - Version](https://img.shields.io/pypi/v/locusts-r-us)

## Description

locusts-r-us is a library that provides a way to introduce locusts into your
code.

Why would you want to do that? I don't know.

## Installation

```sh
pip install locusts-r-us
```

## Example

```python
import locusts

def main():
  locusts.introduce_locusts()
  # Locusts are now in your codebase!

if __name__ == "__main__":
 main()
```

## License

This project is licensed under the BSD Zero Clause License. See the
[LICENSE](../LICENSE) file for details.