Metadata-Version: 2.1
Name: index.py
Version: 0.11.0
Summary: An easy-to-use asynchronous web framework based on ASGI.
Home-page: https://github.com/abersheeran/index.py
License: Apache-2.0
Author: abersheeran
Author-email: me@abersheeran.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Provides-Extra: gunicorn
Provides-Extra: pytest
Provides-Extra: requests
Provides-Extra: test
Requires-Dist: a2wsgi (>=0.3.5,<0.4.0)
Requires-Dist: aiofiles (>=0.5.0,<0.6.0)
Requires-Dist: contextvars (>=2.4,<3.0); python_version >= "3.6" and python_version < "3.7"
Requires-Dist: gunicorn (>=20.0.4,<21.0.0); extra == "gunicorn"
Requires-Dist: jinja2 (>=2.10.3,<3.0.0)
Requires-Dist: pydantic (>=1.5,<2.0)
Requires-Dist: pytest (>=5.4.2,<6.0.0); extra == "pytest" or extra == "test"
Requires-Dist: python-multipart (>=0.0.5,<0.0.6)
Requires-Dist: pyyaml (>=5.3,<6.0)
Requires-Dist: requests (>=2.23.0,<3.0.0); extra == "requests" or extra == "test"
Requires-Dist: starlette (>=0.13.1,<0.14.0)
Requires-Dist: typing-extensions (>=3.7.4,<4.0.0); python_version < "3.8"
Requires-Dist: uvicorn (>=0.11.3,<0.12.0)
Requires-Dist: watchdog (>=0.10.2,<0.11.0)
Project-URL: Documentation, https://index-py.abersheeran.com/
Project-URL: Repository, https://github.com/abersheeran/index.py
Description-Content-Type: text/markdown

# index.py

[![Github Action Test](https://github.com/abersheeran/index.py/workflows/Test/badge.svg)](https://github.com/abersheeran/index.py/actions?query=workflow%3ATest)
[![PyPI](https://img.shields.io/pypi/v/index.py)](https://pypi.org/project/index.py/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/index.py)

一个基于 ASGI 协议的高性能 web 框架。[Index.py 文档](https://abersheeran.github.io/index.py/)

你也可以直接查看 [Example](https://github.com/abersheeran/index.py/tree/master/example) 来学习如何使用（文档偶尔会滞后一到两天，但 example 被纳入了自动化测试，所以会始终保持最新版）

- 无需手动绑定路由 (文件系统映射URI)
- 自动解析请求 & 生成文档 (基于 pydantic)
- 可视化 API 接口 (基于 ReDoc, 针对中文字体优化)
- 现代化的测试组件 (基于 pytest 与 requests)
- 非常简单的部署 (基于 uvicorn 与 gunicorn)
- 支持真正的热重载
- 挂载 ASGI/WSGI 应用 (比 starlette 更易用)
- 更好用的 background tasks
- 可使用任何可用的 ASGI 生态

## Install

```bash
pip install -U index.py
```

或者直接从 Github 上安装最新版本（不稳定）

```bash
pip install -U git+https://github.com/abersheeran/index.py
```

