Metadata-Version: 2.4
Name: AirAdmin
Version: 0.1.0
Summary: Admin UI for Air web framework, inspired by the Django admin and its replacements
Project-URL: bugs, https://github.com/feldroy/AirAdmin/issues
Project-URL: changelog, https://github.com/feldroy/AirAdmin/releases
Project-URL: documentation, https://feldroy.github.io/AirAdmin/
Project-URL: homepage, https://github.com/feldroy/AirAdmin
Author-email: "Audrey M. Roy Greenfeld" <audrey@feldroy.com>
Maintainer-email: "Audrey M. Roy Greenfeld" <audrey@feldroy.com>
License: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: rich
Requires-Dist: typer
Description-Content-Type: text/markdown

# AirAdmin

![PyPI version](https://img.shields.io/pypi/v/AirAdmin.svg)

Admin UI for Air web framework, inspired by the Django admin and its replacements

* [GitHub](https://github.com/feldroy/AirAdmin/) | [PyPI](https://pypi.org/project/AirAdmin/) | [Documentation](https://feldroy.github.io/AirAdmin/)
* Created by [Audrey M. Roy Greenfeld](https://audrey.feldroy.com/) | GitHub [@audreyfeldroy](https://github.com/audreyfeldroy) | PyPI [@audreyr](https://pypi.org/user/audreyr/)
* MIT License

## Features

* TODO

## Documentation

Documentation is built with [Zensical](https://zensical.org/) and deployed to GitHub Pages.

* **Live site:** https://feldroy.github.io/AirAdmin/
* **Preview locally:** `just docs-serve` (serves at http://localhost:8000)
* **Build:** `just docs-build`

API documentation is auto-generated from docstrings using [mkdocstrings](https://mkdocstrings.github.io/).

Docs deploy automatically on push to `main` via GitHub Actions. To enable this, go to your repo's Settings > Pages and set the source to **GitHub Actions**.

## Development

To set up for local development:

```bash
# Clone your fork
git clone git@github.com:your_username/AirAdmin.git
cd AirAdmin

# Install in editable mode with live updates
uv tool install --editable .
```

This installs the CLI globally but with live updates - any changes you make to the source code are immediately available when you run `airadmin`.

Run tests:

```bash
uv run pytest
```

Run quality checks (format, lint, type check, test):

```bash
just qa
```

## Author

AirAdmin was created in 2026 by Audrey M. Roy Greenfeld.

Built with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.
