Skip to content

PECO Outage API

PyPI PyPI - Python Version PyPI - License Coookiecutter - Wolt

Documentation: https://IceBotYT.github.io/peco-outage-api

Source Code: https://github.com/IceBotYT/peco-outage-api

PyPI: https://pypi.org/project/peco/

A library for interacting with the PECO outage map to gain the numbers from it.

Installation

pip install peco

Development

  • Clone this repository
  • Requirements:
  • Poetry
  • Python 3.8+
  • Create a virtual environment and install the dependencies
poetry install
  • Activate the virtual environment
poetry shell

Testing

pytest

Documentation

The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github Pages page automatically as part each release.

Releasing

Trigger the Draft release workflow (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 and publish it. When a release is published, it'll trigger release 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):

pre-commit install

Or if you want them to run only for each push:

pre-commit install -t pre-push

Or if you want e.g. want to run all checks manually for all files:

pre-commit run --all-files

This project was generated using the wolt-python-package-cookiecutter template.