<p align="center">
<em>Quicker FastApi developing tools</em>
</p>
<p align="center">
<a href="https://github.com/yuval9313/fastapi-restful" target="_blank">
<img src="https://img.shields.io/github/last-commit/yuval9313/fastapi-restful.svg">
<img src="https://github.com/yuval9313/FastApi-RESTful/workflows/build/badge.svg" alt="Build CI">
</a>
<a href="https://fastapi-restful.netlify.app">
<img src="https://api.netlify.com/api/v1/badges/294b88e1-4b81-49c0-8525-9c4a2cb782e0/deploy-status" alt="Netlify status">
</a>
<br />
<a href="https://pypi.org/project/FastApi-RESTful" target="_blank">
<img src="https://badge.fury.io/py/fastapi-restful.svg" alt="Package version">
</a>
<a href="https://github.com/yuval9313/fastapi-restful" target="_blank">
<img src="https://img.shields.io/pypi/pyversions/FastApi-RESTful.svg" alt="Python versions">
<img src="https://img.shields.io/github/license/yuval9313/FastApi-RESTful.svg" alt="License">
</a>
</p>
---
**Documentation**: <a href="https://fastapi-restful.netlify.app" target="_blank">https://fastapi-restful.netlify.app</a>
**Source Code**: <a href="https://github.com/yuval9313/fastapi-restful" target="_blank">https://github.com/yuval9313/fastapi-restful</a>
Base on: <a href="https://github.com/dmontagu/fastapi-utils" target="_blank">https://github.com/dmontagu/fastapi-utils</a>
---
<a href="https://fastapi.tiangolo.com">FastAPI</a> is a modern, fast web framework for building APIs with Python 3.7+.
But if you're here, you probably already knew that!
---
## Features
This package includes a number of utilities to help reduce boilerplate and reuse common functionality across projects:
* **Resource Class**: Create CRUD with ease the OOP way with `Resource` base class that lets you implement methods quick.
* **Class Based Views**: Stop repeating the same dependencies over and over in the signature of related endpoints.
* **Repeated Tasks**: Easily trigger periodic tasks on server startup
* **Timing Middleware**: Log basic timing information for every request
* **OpenAPI Spec Simplification**: Simplify your OpenAPI Operation IDs for cleaner output from OpenAPI Generator
* **SQLAlchemy Sessions**: The `FastAPISessionMaker` class provides an easily-customized SQLAlchemy Session dependency
---
It also adds a variety of more basic utilities that are useful across a wide variety of projects:
* **APIModel**: A reusable `pydantic.BaseModel`-derived base class with useful defaults
* **APISettings**: A subclass of `pydantic.BaseSettings` that makes it easy to configure FastAPI through environment variables
* **String-Valued Enums**: The `StrEnum` and `CamelStrEnum` classes make string-valued enums easier to maintain
* **CamelCase Conversions**: Convenience functions for converting strings from `snake_case` to `camelCase` or `PascalCase` and back
* **GUID Type**: The provided GUID type makes it easy to use UUIDs as the primary keys for your database tables
See the [docs](https://fastapi-restful.netlify.app/) for more details and examples.
## Requirements
This package is intended for use with any recent version of FastAPI (depending on `pydantic>=1.0`), and Python 3.7+.
## Installation
```bash
pip install fastapi-restful # For basic slim package :)
pip install fastapi-restful[session] # To add sqlalchemy session maker
pip install fastapi-restful[all] # For all the packages
```
## License
This project is licensed under the terms of the MIT license.
Raw data
{
"_id": null,
"home_page": "https://fastapi-restful.netlify.app",
"name": "fastapi-restful",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "fastapi, OOP, RESTful",
"author": "Yuval Levi",
"author_email": "yuvall9313@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/53/ad/ea9cc9958dfa9daf8f4358de7021b24f9c5f257be3137a75179713d9b110/fastapi_restful-0.6.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <em>Quicker FastApi developing tools</em>\n</p>\n<p align=\"center\">\n<a href=\"https://github.com/yuval9313/fastapi-restful\" target=\"_blank\">\n\t<img src=\"https://img.shields.io/github/last-commit/yuval9313/fastapi-restful.svg\">\n\t<img src=\"https://github.com/yuval9313/FastApi-RESTful/workflows/build/badge.svg\" alt=\"Build CI\">\n</a>\n<a href=\"https://fastapi-restful.netlify.app\">\n <img src=\"https://api.netlify.com/api/v1/badges/294b88e1-4b81-49c0-8525-9c4a2cb782e0/deploy-status\" alt=\"Netlify status\">\n</a>\n<br />\n<a href=\"https://pypi.org/project/FastApi-RESTful\" target=\"_blank\">\n <img src=\"https://badge.fury.io/py/fastapi-restful.svg\" alt=\"Package version\">\n</a>\n<a href=\"https://github.com/yuval9313/fastapi-restful\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/pyversions/FastApi-RESTful.svg\" alt=\"Python versions\">\n <img src=\"https://img.shields.io/github/license/yuval9313/FastApi-RESTful.svg\" alt=\"License\">\n</a>\n</p>\n\n---\n\n**Documentation**: <a href=\"https://fastapi-restful.netlify.app\" target=\"_blank\">https://fastapi-restful.netlify.app</a>\n\n**Source Code**: <a href=\"https://github.com/yuval9313/fastapi-restful\" target=\"_blank\">https://github.com/yuval9313/fastapi-restful</a>\n\nBase on: <a href=\"https://github.com/dmontagu/fastapi-utils\" target=\"_blank\">https://github.com/dmontagu/fastapi-utils</a>\n\n---\n\n<a href=\"https://fastapi.tiangolo.com\">FastAPI</a> is a modern, fast web framework for building APIs with Python 3.7+.\n\nBut if you're here, you probably already knew that!\n\n---\n\n## Features\n\nThis package includes a number of utilities to help reduce boilerplate and reuse common functionality across projects:\n\n* **Resource Class**: Create CRUD with ease the OOP way with `Resource` base class that lets you implement methods quick.\n* **Class Based Views**: Stop repeating the same dependencies over and over in the signature of related endpoints.\n* **Repeated Tasks**: Easily trigger periodic tasks on server startup\n* **Timing Middleware**: Log basic timing information for every request\n* **OpenAPI Spec Simplification**: Simplify your OpenAPI Operation IDs for cleaner output from OpenAPI Generator\n* **SQLAlchemy Sessions**: The `FastAPISessionMaker` class provides an easily-customized SQLAlchemy Session dependency\n\n---\n\nIt also adds a variety of more basic utilities that are useful across a wide variety of projects:\n\n* **APIModel**: A reusable `pydantic.BaseModel`-derived base class with useful defaults\n* **APISettings**: A subclass of `pydantic.BaseSettings` that makes it easy to configure FastAPI through environment variables\n* **String-Valued Enums**: The `StrEnum` and `CamelStrEnum` classes make string-valued enums easier to maintain\n* **CamelCase Conversions**: Convenience functions for converting strings from `snake_case` to `camelCase` or `PascalCase` and back\n* **GUID Type**: The provided GUID type makes it easy to use UUIDs as the primary keys for your database tables\n\nSee the [docs](https://fastapi-restful.netlify.app/) for more details and examples.\n\n## Requirements\n\nThis package is intended for use with any recent version of FastAPI (depending on `pydantic>=1.0`), and Python 3.7+.\n\n## Installation\n\n```bash\npip install fastapi-restful # For basic slim package :)\n\npip install fastapi-restful[session] # To add sqlalchemy session maker\n\npip install fastapi-restful[all] # For all the packages\n```\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Quicker FastApi developing tools",
"version": "0.6.0",
"project_urls": {
"Documentation": "https://fastapi-restful.netlify.app",
"Homepage": "https://fastapi-restful.netlify.app",
"Repository": "https://github.com/yuval9313/FastApi-RESTful"
},
"split_keywords": [
"fastapi",
" oop",
" restful"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b8db5ac6d4e30e374f416145df3e6c6d9b07818bc33891982bfaabe5b960cba",
"md5": "2414aa273d3e07b2c57b9a9c54cea027",
"sha256": "d7f6f7c6cc329e11fd8584876560f624989168ddc1bc22cc9998da4ab4f546a3"
},
"downloads": -1,
"filename": "fastapi_restful-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2414aa273d3e07b2c57b9a9c54cea027",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 18400,
"upload_time": "2024-05-07T22:46:11",
"upload_time_iso_8601": "2024-05-07T22:46:11.400463Z",
"url": "https://files.pythonhosted.org/packages/8b/8d/b5ac6d4e30e374f416145df3e6c6d9b07818bc33891982bfaabe5b960cba/fastapi_restful-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "53adea9cc9958dfa9daf8f4358de7021b24f9c5f257be3137a75179713d9b110",
"md5": "45096c8f618877a34ad672df9142c765",
"sha256": "75cde98b19224dfa424e7fa1b04b51d4787b02e38fae6c1436815857bc3e8179"
},
"downloads": -1,
"filename": "fastapi_restful-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "45096c8f618877a34ad672df9142c765",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 16189,
"upload_time": "2024-05-07T22:46:13",
"upload_time_iso_8601": "2024-05-07T22:46:13.239143Z",
"url": "https://files.pythonhosted.org/packages/53/ad/ea9cc9958dfa9daf8f4358de7021b24f9c5f257be3137a75179713d9b110/fastapi_restful-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-07 22:46:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yuval9313",
"github_project": "FastApi-RESTful",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fastapi-restful"
}
JSON
