Metadata-Version: 2.4
Name: electricity-outage-checker
Version: 1.0.2
Summary: CLI tool to check electricity outage schedules
Author-email: whoisridze <spatter-pinyons6o@icloud.com>
License: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Requires-Dist: httpx>=0.27.0
Requires-Dist: rich>=13.7.0
Requires-Dist: typer>=0.9.0
Provides-Extra: dev
Requires-Dist: mypy>=1.8.0; extra == 'dev'
Requires-Dist: ruff>=0.2.0; extra == 'dev'
Description-Content-Type: text/markdown

<div align="center">

# Electricity Outage Checker

[![Release version](https://img.shields.io/github/v/release/whoisridze/electricity-outage-checker?color=brightgreen&label=Release&style=for-the-badge)](https://github.com/whoisridze/electricity-outage-checker/releases/latest "Latest Release")
[![PyPI](https://img.shields.io/badge/-PyPI-blue.svg?logo=pypi&labelColor=555555&style=for-the-badge)](https://pypi.org/project/electricity-outage-checker "PyPI")
[![Python](https://img.shields.io/pypi/pyversions/electricity-outage-checker?logo=python&labelColor=555555&style=for-the-badge)](https://pypi.org/project/electricity-outage-checker "Python version")

*CLI tool to check DTEK electricity outage schedules*

</div>

## Installation

### Install from PyPI

```bash
pip install electricity-outage-checker
outage-checker --help
```

### Install from source

```bash
git clone https://github.com/whoisridze/electricity-outage-checker.git
cd electricity-outage-checker
uv sync
uv run outage-checker --help
```

## Usage

```bash
# Check outage schedule for an address
outage-checker check "<city>, <street>, <house>"

# Set a default address
outage-checker set-address "<city>, <street>, <house>"

# Check using default address
outage-checker check

# List available cities
outage-checker list-cities

# List streets in a city
outage-checker list-streets "<city>"

# List houses on a street
outage-checker list-houses "<city>" "<street>"

# Show version
outage-checker --version
```

## Development

```bash
# Install dev dependencies
uv sync

# Run linter
uv run ruff check .

# Format code
uv run ruff format .
uv run ruff check --fix .

# Run type checker
uv run mypy src/
```

## Project Structure

```
electricity-outage-checker/
├── src/
│   └── electricity_outage_checker/
│       ├── __init__.py
│       ├── cli.py          # CLI entry point
│       ├── client.py       # DTEK API client
│       ├── config.py       # User configuration
│       ├── models.py       # Data models
│       └── py.typed        # PEP 561 marker
├── pyproject.toml          # Project configuration
└── README.md
```

## License

MIT
