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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# PECO Outage API
[](https://pypi.python.org/pypi/peco/)
[](https://pypi.python.org/pypi/peco/)
[](https://pypi.python.org/pypi/peco/)
[](https://github.com/woltapp/wolt-python-package-cookiecutter)
---
**Documentation**: [https://IceBotYT.github.io/peco-outage-api](https://IceBotYT.github.io/peco-outage-api)
**Source Code**: [https://github.com/IceBotYT/peco-outage-api](https://github.com/IceBotYT/peco-outage-api)
**PyPI**: [https://pypi.org/project/peco/](https://pypi.org/project/peco/)
---
A library for interacting with the PECO outage map to gain the numbers from it.
## Installation
```sh
pip install peco
```
## Development
* Clone this repository
* Requirements:
* [Poetry](https://python-poetry.org/)
* Python 3.8+
* Create a virtual environment and install the dependencies
```sh
poetry install
```
* Activate the virtual environment
```sh
poetry shell
```
### Testing
```sh
pytest
```
### Documentation
The documentation is automatically generated from the content of the [docs directory](https://github.com/IceBotYT/peco-outage-api/tree/master/docs) and from the docstrings
of the public signatures of the source code. The documentation is updated and published as a [Github Pages page](https://pages.github.com/) automatically as part each release.
### Releasing
Trigger the [Draft release workflow](https://github.com/IceBotYT/peco-outage-api/actions/workflows/draft_release.yml)
(press _Run workflow_). This will update the changelog & version and create a GitHub release which is in _Draft_ state.
Find the draft release from the
[GitHub releases](https://github.com/IceBotYT/peco-outage-api/releases) and publish it. When
a release is published, it'll trigger [release](https://github.com/IceBotYT/peco-outage-api/blob/master/.github/workflows/release.yml) workflow which creates PyPI
release and deploys updated documentation.
### Pre-commit
Pre-commit hooks run all the auto-formatting (`ruff format`), linters (e.g. `ruff` and `mypy`), and other quality
checks to make sure the changeset is in good shape before a commit/push happens.
You can install the hooks with (runs for each commit):
```sh
pre-commit install
```
Or if you want them to run only for each push:
```sh
pre-commit install -t pre-push
```
Or if you want e.g. want to run all checks manually for all files:
```sh
pre-commit run --all-files
```
---
This project was generated using the [wolt-python-package-cookiecutter](https://github.com/woltapp/wolt-python-package-cookiecutter) template.
|
