| Name | air JSON |
| Version |
0.36.0
JSON |
| download |
| home_page | None |
| Summary | The new Python web framework by the authors of Two Scoops of Django. Built with FastAPI, Starlette, and Pydantic. |
| upload_time | 2025-10-10 15:27:05 |
| maintainer | None |
| docs_url | None |
| author | Audrey M. Roy Greenfeld, Daniel Roy Greenfeld |
| requires_python | <3.15,>=3.13 |
| license | MIT License Copyright (c) 2025 Daniel and Audrey Roy Greenfeld Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="https://raw.githubusercontent.com/feldroy/air/refs/heads/main/img/air-neon.svg" />
</p>
## Air 💨: The new web framework that breathes fresh air into Python web development. Built with FastAPI, Starlette, and Pydantic.
[](https://github.com/feldroy/air/actions/workflows/python-package.yml?query=branch%3Amain+event%3Apush)
[](https://github.com/feldroy/air/actions/workflows/python-package.yml?query=tag%3Alatest+event%3Apush)
[](https://codecov.io/gh/feldroy/air)
[](https://github.com/feldroy/air/blob/main/LICENSE)
[](https://pypi.org/project/air)
[](https://pepy.tech/projects/air)
[](https://pepy.tech/projects/air)
[](https://pepy.tech/projects/air)
[](https://pypi.org/project/air)
[](https://github.com/feldroy/air/commit/main)
[](https://github.com/feldroy/air/releases/latest)
[](https://github.com/feldroy/air/graphs/contributors)
[](https://discord.gg/nhPNn4bw6R)
[](https://x.com/AirWebFramework)
[](https://bsky.app/profile/airwebframework.bsky.social)
[](https://feldroy.github.io/air)
[](https://fastapi.tiangolo.com)
[](https://docs.pydantic.dev/latest)
[](https://jinja.palletsprojects.com/en/latest)
[](https://docs.astral.sh)
> [!CAUTION]
> Air is currently in an alpha state. While breaking changes are becoming less common, nevertheless, anything and everything could change.
> [!IMPORTANT]
> If you have an idea for a new feature, discuss it with us by opening an issue before writing any code. Do understand that we are working to remove features from core, and for new features you will almost always create your own package that extends or uses Air instead of adding to this package. This is by design, as our vision is for the Air package ecosystem to be as much a "core" part of Air as the code in this minimalist base package.
## Why use Air?
- **Powered by FastAPI** - Designed to work with FastAPI so you can serve your API and web pages from one app
- **Fast to code** - Tons of intuitive shortcuts and optimizations designed to expedite coding HTML with FastAPI
- **Air Tags** - Easy to write and performant HTML content generation using Python classes to render HTML
- **Jinja Friendly** - No need to write `response_class=HtmlResponse` and `templates.TemplateResponse` for every HTML view
- **Mix Jinja and Air Tags** - Jinja and Air Tags both are first class citizens. Use either or both in the same view!
- **HTMX friendly** - We love HTMX and provide utilities to use it with Air
- **HTML form validation powered by pydantic** - We love using pydantic to validate incoming data. Air Forms provide two ways to use pydantic with HTML forms (dependency injection or from within views)
- **Easy to learn yet well documented** - Hopefully Air is so intuitive and well-typed you'll barely need to use the documentation. In case you do need to look something up we're taking our experience writing technical books and using it to make documentation worth boasting about
---
**Documentation**: <a href="https://airdocs.fastapicloud.dev/" target="_blank">https://airdocs.fastapicloud.dev</a>
**Source Code**: <a href="https://github.com/feldroy/air" target="_blank">https://github.com/feldroy/air</a>
## Installation
Install using `pip install -U air` or `conda install air -c conda-forge`.
For `uv` users, just create a virtualenv and install the air package, like:
```sh
uv venv
source .venv/bin/activate
uv init
uv add air
```
### Install optional features (with `uv add`)
You can install each optional feature (extras) like this:
1. **Standard** — FastAPI’s recommended extras
```sh
uv add "air[standard]"
```
2. **Pretty** — Beautiful HTML Rendering (lxml, rich)
```sh
uv add "air[pretty]"
```
3. **SQL** — SQLModel / SQLAlchemy support
```sh
uv add "air[sql]"
```
4. **Auth** — OAuth clients via Authlib
```sh
uv add "air[auth]"
```
5. **All** — everything above in one go
```sh
uv add "air[all]"
```
> Tip: you can also combine extras in one command, for example:
> `uv add "air[pretty,sql]"`
## A Simple Example
Create a `main.py` with:
```python
import air
app = air.Air()
@app.get("/")
async def index():
return air.Html(air.H1("Hello, world!", style="color: blue;"))
```
Run the app with:
```sh
fastapi dev
```
If you have fastapi installed globally, you may see an error:
```sh
To use the fastapi command, please install "fastapi[standard]":
pip install "fastapi[standard]"
```
In that case, run the app with:
```sh
uv run fastapi dev
```
> [!NOTE]
> This example uses Air Tags, which are Python classes that render as HTML. Air Tags are typed and documented, designed to work well with any code completion tool.
> You can also run this with `uv run uvicorn main:app --reload` if you prefer using Uvicorn directly.
Then open your browser to <http://127.0.0.1:8000> to see the result.
## Combining FastAPI and Air
Air is just a layer over FastAPI. So it is trivial to combine sophisticated HTML pages and a REST API into one app.
```python
import air
from fastapi import FastAPI
app = air.Air()
api = FastAPI()
@app.get("/")
def landing_page():
return air.Html(
air.Head(air.Title("Awesome SaaS")),
air.Body(
air.H1("Awesome SaaS"),
air.P(air.A("API Docs", target="_blank", href="/api/docs")),
),
)
@api.get("/")
def api_root():
return {"message": "Awesome SaaS is powered by FastAPI"}
# Combining the Air and and FastAPI apps into one
app.mount("/api", api)
```
## Combining FastAPI and Air using Jinja2
Want to use Jinja2 instead of Air Tags? We've got you covered.
```python
import air
from air.requests import Request
from fastapi import FastAPI
app = air.Air()
api = FastAPI()
# Air's JinjaRenderer is a shortcut for using Jinja templates
jinja = air.JinjaRenderer(directory="templates")
@app.get("/")
def index(request: Request):
return jinja(request, name="home.html")
@api.get("/")
def api_root():
return {"message": "Awesome SaaS is powered by FastAPI"}
# Combining the Air and and FastAPI apps into one
app.mount("/api", api)
```
Don't forget the Jinja template!
```html
<!doctype html
<html>
<head>
<title>Awesome SaaS</title>
</head>
<body>
<h1>Awesome SaaS</h1>
<p>
<a target="_blank" href="/api/docs">API Docs</a>
</p>
</body>
</html>
```
> [!NOTE]
> Using Jinja with Air is easier than with FastAPI. That's because as much as we enjoy Air Tags, we also love Jinja!
## Contributing
For guidance on setting up a development environment and how to make a contribution to Air, see [Contributing to Air](https://github.com/feldroy/air/blob/main/CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "air",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.15,>=3.13",
"maintainer_email": null,
"keywords": null,
"author": "Audrey M. Roy Greenfeld, Daniel Roy Greenfeld",
"author_email": "Audrey M. Roy Greenfeld <audrey@feldroy.com>, Daniel Roy Greenfeld <daniel@feldroy.com>",
"download_url": "https://files.pythonhosted.org/packages/5a/d8/54245c2b6fcf7746dc5f6323ed218c36bb7b7a6061ed6b6e822d63e0ea80/air-0.36.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/feldroy/air/refs/heads/main/img/air-neon.svg\" />\n</p>\n\n## Air \ud83d\udca8: The new web framework that breathes fresh air into Python web development. Built with FastAPI, Starlette, and Pydantic.\n\n[](https://github.com/feldroy/air/actions/workflows/python-package.yml?query=branch%3Amain+event%3Apush)\n[](https://github.com/feldroy/air/actions/workflows/python-package.yml?query=tag%3Alatest+event%3Apush)\n[](https://codecov.io/gh/feldroy/air)\n[](https://github.com/feldroy/air/blob/main/LICENSE)\n\n[](https://pypi.org/project/air)\n[](https://pepy.tech/projects/air)\n[](https://pepy.tech/projects/air)\n[](https://pepy.tech/projects/air)\n\n\n\n\n\n[](https://pypi.org/project/air)\n\n\n\n[](https://github.com/feldroy/air/commit/main)\n[](https://github.com/feldroy/air/releases/latest)\n\n[](https://github.com/feldroy/air/graphs/contributors)\n[](https://discord.gg/nhPNn4bw6R)\n[](https://x.com/AirWebFramework)\n[](https://bsky.app/profile/airwebframework.bsky.social)\n[](https://feldroy.github.io/air)\n\n\n[](https://fastapi.tiangolo.com)\n[](https://docs.pydantic.dev/latest)\n[](https://jinja.palletsprojects.com/en/latest)\n[](https://docs.astral.sh)\n\n> [!CAUTION]\n> Air is currently in an alpha state. While breaking changes are becoming less common, nevertheless, anything and everything could change.\n\n\n> [!IMPORTANT]\n> If you have an idea for a new feature, discuss it with us by opening an issue before writing any code. Do understand that we are working to remove features from core, and for new features you will almost always create your own package that extends or uses Air instead of adding to this package. This is by design, as our vision is for the Air package ecosystem to be as much a \"core\" part of Air as the code in this minimalist base package.\n\n## Why use Air?\n\n\n- **Powered by FastAPI** - Designed to work with FastAPI so you can serve your API and web pages from one app\n- **Fast to code** - Tons of intuitive shortcuts and optimizations designed to expedite coding HTML with FastAPI\n- **Air Tags** - Easy to write and performant HTML content generation using Python classes to render HTML\n- **Jinja Friendly** - No need to write `response_class=HtmlResponse` and `templates.TemplateResponse` for every HTML view\n- **Mix Jinja and Air Tags** - Jinja and Air Tags both are first class citizens. Use either or both in the same view!\n- **HTMX friendly** - We love HTMX and provide utilities to use it with Air\n- **HTML form validation powered by pydantic** - We love using pydantic to validate incoming data. Air Forms provide two ways to use pydantic with HTML forms (dependency injection or from within views)\n- **Easy to learn yet well documented** - Hopefully Air is so intuitive and well-typed you'll barely need to use the documentation. In case you do need to look something up we're taking our experience writing technical books and using it to make documentation worth boasting about\n\n---\n\n**Documentation**: <a href=\"https://airdocs.fastapicloud.dev/\" target=\"_blank\">https://airdocs.fastapicloud.dev</a>\n\n**Source Code**: <a href=\"https://github.com/feldroy/air\" target=\"_blank\">https://github.com/feldroy/air</a>\n\n\n## Installation\n\nInstall using `pip install -U air` or `conda install air -c conda-forge`.\n\nFor `uv` users, just create a virtualenv and install the air package, like:\n\n```sh\nuv venv\nsource .venv/bin/activate\nuv init\nuv add air\n```\n### Install optional features (with `uv add`)\n\nYou can install each optional feature (extras) like this:\n1. **Standard** \u2014 FastAPI\u2019s recommended extras\n ```sh\n uv add \"air[standard]\"\n ```\n2. **Pretty** \u2014 Beautiful HTML Rendering (lxml, rich)\n ```sh\n uv add \"air[pretty]\"\n ```\n3. **SQL** \u2014 SQLModel / SQLAlchemy support\n ```sh\n uv add \"air[sql]\"\n ```\n4. **Auth** \u2014 OAuth clients via Authlib\n ```sh\n uv add \"air[auth]\"\n ```\n5. **All** \u2014 everything above in one go\n ```sh\n uv add \"air[all]\"\n ```\n> Tip: you can also combine extras in one command, for example:\n> `uv add \"air[pretty,sql]\"`\n\n## A Simple Example\n\nCreate a `main.py` with:\n\n```python\nimport air\n\napp = air.Air()\n\n\n@app.get(\"/\")\nasync def index():\n return air.Html(air.H1(\"Hello, world!\", style=\"color: blue;\"))\n```\n\nRun the app with:\n\n```sh\nfastapi dev\n```\n\nIf you have fastapi installed globally, you may see an error:\n```sh\nTo use the fastapi command, please install \"fastapi[standard]\":\n\n\tpip install \"fastapi[standard]\"\n```\nIn that case, run the app with:\n```sh\nuv run fastapi dev\n```\n\n> [!NOTE]\n> This example uses Air Tags, which are Python classes that render as HTML. Air Tags are typed and documented, designed to work well with any code completion tool.\n> You can also run this with `uv run uvicorn main:app --reload` if you prefer using Uvicorn directly.\n\nThen open your browser to <http://127.0.0.1:8000> to see the result.\n\n## Combining FastAPI and Air\n\nAir is just a layer over FastAPI. So it is trivial to combine sophisticated HTML pages and a REST API into one app.\n\n```python\nimport air\nfrom fastapi import FastAPI\n\napp = air.Air()\napi = FastAPI()\n\n@app.get(\"/\")\ndef landing_page():\n return air.Html(\n air.Head(air.Title(\"Awesome SaaS\")),\n air.Body(\n air.H1(\"Awesome SaaS\"),\n air.P(air.A(\"API Docs\", target=\"_blank\", href=\"/api/docs\")),\n ),\n )\n\n\n@api.get(\"/\")\ndef api_root():\n return {\"message\": \"Awesome SaaS is powered by FastAPI\"}\n\n# Combining the Air and and FastAPI apps into one\napp.mount(\"/api\", api)\n```\n\n## Combining FastAPI and Air using Jinja2\n\nWant to use Jinja2 instead of Air Tags? We've got you covered.\n\n```python\nimport air\nfrom air.requests import Request\nfrom fastapi import FastAPI\n\napp = air.Air()\napi = FastAPI()\n\n# Air's JinjaRenderer is a shortcut for using Jinja templates\njinja = air.JinjaRenderer(directory=\"templates\")\n\n@app.get(\"/\")\ndef index(request: Request):\n return jinja(request, name=\"home.html\")\n\n@api.get(\"/\")\ndef api_root():\n return {\"message\": \"Awesome SaaS is powered by FastAPI\"}\n\n# Combining the Air and and FastAPI apps into one\napp.mount(\"/api\", api)\n```\n\nDon't forget the Jinja template!\n\n```html\n<!doctype html\n<html>\n <head>\n <title>Awesome SaaS</title>\n </head>\n <body>\n <h1>Awesome SaaS</h1>\n <p>\n <a target=\"_blank\" href=\"/api/docs\">API Docs</a>\n </p>\n </body>\n</html>\n```\n\n> [!NOTE]\n> Using Jinja with Air is easier than with FastAPI. That's because as much as we enjoy Air Tags, we also love Jinja!\n\n## Contributing\n\nFor guidance on setting up a development environment and how to make a contribution to Air, see [Contributing to Air](https://github.com/feldroy/air/blob/main/CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 Daniel and Audrey Roy Greenfeld Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "The new Python web framework by the authors of Two Scoops of Django. Built with FastAPI, Starlette, and Pydantic.",
"version": "0.36.0",
"project_urls": {
"Changelog": "https://github.com/feldroy/air/blob/main/CHANGELOG.md",
"Docs": "https://feldroy.github.io/air/",
"Homepage": "https://github.com/feldroy/air",
"Issues": "https://github.com/feldroy/air/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c6c7414ad47fd6feec5e9a857de7f199a87c1143c52ce2aa0493106300f459be",
"md5": "1f2fa06aec35571534913c165c382427",
"sha256": "2b10c595e1c60f6cfe2a2e3aa08f27383464e871cdfd2eb52f4458b5c0f875a9"
},
"downloads": -1,
"filename": "air-0.36.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f2fa06aec35571534913c165c382427",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.15,>=3.13",
"size": 60059,
"upload_time": "2025-10-10T15:27:04",
"upload_time_iso_8601": "2025-10-10T15:27:04.002194Z",
"url": "https://files.pythonhosted.org/packages/c6/c7/414ad47fd6feec5e9a857de7f199a87c1143c52ce2aa0493106300f459be/air-0.36.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5ad854245c2b6fcf7746dc5f6323ed218c36bb7b7a6061ed6b6e822d63e0ea80",
"md5": "ebd87018b7482254626160125540ff93",
"sha256": "b4257d6c8cb3058c0f4db64f3189b51a4263de48651f935259f4ac544b0d958e"
},
"downloads": -1,
"filename": "air-0.36.0.tar.gz",
"has_sig": false,
"md5_digest": "ebd87018b7482254626160125540ff93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.15,>=3.13",
"size": 60275,
"upload_time": "2025-10-10T15:27:05",
"upload_time_iso_8601": "2025-10-10T15:27:05.419559Z",
"url": "https://files.pythonhosted.org/packages/5a/d8/54245c2b6fcf7746dc5f6323ed218c36bb7b7a6061ed6b6e822d63e0ea80/air-0.36.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-10 15:27:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "feldroy",
"github_project": "air",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "air"
}
