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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
# Contributing to *aioswitcher*
:clap: First off, thank you for taking the time to contribute. :clap:
Contributing is pretty straight-forward:
- Fork the repository
- Create a new branch on your fork
- Commit your changes
- Create a pull request against the `dev` branch
## Installing
### Install remote development version
Contributions are welcome in all shapes or forms. If you're a user, you can play around with the current development
version and report back any findings.
Install the remote development version using `pip`:
```shell
pip install git+https://github.com/TomerFi/aioswitcher#dev
```
### Install local development version
If you need to test your changes locally, you can install your work-in-progress from your active working branch.
Install the local development version using `pip`:
```shell
pip install --upgrade .
```
## Developing
### Prepare the development environment
With [Python >= 3.10][python-site] use [pip][pip-docs] to install [poetry][poetry-site]:
```shell
pip install -r requirements.txt
```
### Get started with poetry
After installing, run [poe][poethepoet-site] for _help_, this will list the available tasks:
```shell
poetry install # install all dependencies and the current project
poetry run poe --help # display all available tasks
```
Common [poe][poethepoet-site] tasks:
```shell
poetry run poe test # will run all unit-tests
poetry run poe lint # will lint the project using black, flake8, isort, mypy, and yamllint
poetry run poe docs_serve # will build and serve a local version of the documentation site
```
## Documentation
We use [MkDocs][mkdocs-site] and [Material][material-site] for building our documentation site,
https://aioswitcher.figenblat.com/. See [docs](docs) and [mkdocs.yml](mkdocs.yml).
> [!NOTE]
> We're generating [code documentation][aioswitcher-code-docs] from _docstrings_.
<!-- Links -->
[aioswitcher-code-docs]: https://aioswitcher.figenblat.com/codedocs/
[material-site]: https://squidfunk.github.io/mkdocs-material/
[mkdocs-site]: https://www.mkdocs.org/
[pip-docs]: https://pypi.org/project/pip/
[poethepoet-site]: https://github.com/nat-n/poethepoet
[poetry-site]: https://poetry.eustace.io/
[python-site]: https://www.python.org/
|
