Name | Flask-Lan JSON |
Version |
0.1.12
JSON |
| download |
home_page | None |
Summary | Modernized Flask API builder with schema validator and OpenAPI |
upload_time | 2022-12-16 15:13:26 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.8 |
license | None |
keywords |
api
flask
openapi
plugin
validator
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Flask-Lan
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ischaojie/flask-lan/CI?style=flat-square)
[![codecov](https://codecov.io/gh/ischaojie/flask-lan/branch/main/graph/badge.svg?token=FPBE0LGDCO)](https://codecov.io/gh/ischaojie/flask-lan)
[![PyPI](https://img.shields.io/pypi/v/flask-lan?style=flat-square)](https://pypi.org/project/Flask-Lan/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flask-lan?style=flat-square)
![GitHub](https://img.shields.io/github/license/ischaojie/flask-lan?style=flat-square)
> **Warning**
>
> Flask-Lan has been renamed to [Flask-More](https://github.com/ischaojie/flask-more). Please use the new name instead.
Modernized Flask API builder with schema validator and OpenAPI.
> **Warning**
>
> Currently, `Flask-Lan` is still under active development(before v1.0.0).
>
> Don't use it in production.
Flask-Lan is kind of like the famous library [FastAPI](https://github.com/tiangolo/fastapi), bringing part of its brilliant features to your Flask application, you can see a lot of similarities between the two.
For example, it uses [Pydantic](https://github.com/samuelcolvin/pydantic) for request and response validation,
it will auto-generate `OpenAPI` API docs and so on.
## Feature
- Intuitive and easy to use.
- Request/Response validation based on type hinting(by Pydantic).
- Auto-generated `OpenAPI` docs(both swagger and redoc).
- Designed for API development.
## Quick start
```bash
python -m pip install Flask-Lan
```
You can view and run the code in the [example](/example/) file.
Then open [http://127.0.0.1:5000/docs](http://127.0.0.1:5000/docs) you will see the API docs like this:
![docs](https://img.chaojie.fun/flask-lan-docs.png)
Read the [docs](https://flask-lan.chaojie.fun/) to get more details.
## License
This project is licensed under the terms of the MIT license.
Raw data
{
"_id": null,
"home_page": null,
"name": "Flask-Lan",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "api,flask,openapi,plugin,validator",
"author": null,
"author_email": "chaojie <zhuzhezhe95@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/52/7e/374317e15e4ee221545fa11f73a852705a63a7163acfe799115996fc8525/flask_lan-0.1.12.tar.gz",
"platform": null,
"description": "# Flask-Lan\n\n![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ischaojie/flask-lan/CI?style=flat-square)\n[![codecov](https://codecov.io/gh/ischaojie/flask-lan/branch/main/graph/badge.svg?token=FPBE0LGDCO)](https://codecov.io/gh/ischaojie/flask-lan)\n[![PyPI](https://img.shields.io/pypi/v/flask-lan?style=flat-square)](https://pypi.org/project/Flask-Lan/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flask-lan?style=flat-square)\n![GitHub](https://img.shields.io/github/license/ischaojie/flask-lan?style=flat-square)\n\n> **Warning**\n>\n> Flask-Lan has been renamed to [Flask-More](https://github.com/ischaojie/flask-more). Please use the new name instead.\n\n\nModernized Flask API builder with schema validator and OpenAPI.\n\n\n> **Warning**\n>\n> Currently, `Flask-Lan` is still under active development(before v1.0.0).\n>\n> Don't use it in production.\n\nFlask-Lan is kind of like the famous library [FastAPI](https://github.com/tiangolo/fastapi), bringing part of its brilliant features to your Flask application, you can see a lot of similarities between the two.\n\nFor example, it uses [Pydantic](https://github.com/samuelcolvin/pydantic) for request and response validation,\nit will auto-generate `OpenAPI` API docs and so on.\n\n## Feature\n\n- Intuitive and easy to use.\n- Request/Response validation based on type hinting(by Pydantic).\n- Auto-generated `OpenAPI` docs(both swagger and redoc).\n- Designed for API development.\n\n## Quick start\n\n```bash\npython -m pip install Flask-Lan\n```\n\nYou can view and run the code in the [example](/example/) file.\nThen open [http://127.0.0.1:5000/docs](http://127.0.0.1:5000/docs) you will see the API docs like this:\n\n![docs](https://img.chaojie.fun/flask-lan-docs.png)\n\nRead the [docs](https://flask-lan.chaojie.fun/) to get more details.\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n",
"bugtrack_url": null,
"license": null,
"summary": "Modernized Flask API builder with schema validator and OpenAPI",
"version": "0.1.12",
"split_keywords": [
"api",
"flask",
"openapi",
"plugin",
"validator"
],
"urls": [
{
"comment_text": null,
"digests": {
"md5": "5b82e004850d583d2f3009cc202e6630",
"sha256": "9d2bdbd8caf21bd332491643396b00932fe0232c4c8c2479c0dc3adef5b5c276"
},
"downloads": -1,
"filename": "flask_lan-0.1.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b82e004850d583d2f3009cc202e6630",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11679,
"upload_time": "2022-12-16T15:13:30",
"upload_time_iso_8601": "2022-12-16T15:13:30.024286Z",
"url": "https://files.pythonhosted.org/packages/74/14/1f4a11e13c4ba1f905b48e83ec835b894795072ef5acdce2e6650cff3516/flask_lan-0.1.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"md5": "6aa3803b2c81513bb0973bd4fb75fdc3",
"sha256": "3e2ce55bed8ba289fb52dc4caa7a9a4a9682eab9846be2d9116af7acca497d6c"
},
"downloads": -1,
"filename": "flask_lan-0.1.12.tar.gz",
"has_sig": false,
"md5_digest": "6aa3803b2c81513bb0973bd4fb75fdc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13582,
"upload_time": "2022-12-16T15:13:26",
"upload_time_iso_8601": "2022-12-16T15:13:26.438242Z",
"url": "https://files.pythonhosted.org/packages/52/7e/374317e15e4ee221545fa11f73a852705a63a7163acfe799115996fc8525/flask_lan-0.1.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-16 15:13:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "flask-lan"
}