| Name | create-fastapi-app JSON |
| Version |
0.4.4
JSON |
| download |
| home_page | |
| Summary | Wrapper for initializing FastAPI projects - Create Fastapi App |
| upload_time | 2023-03-17 11:33:10 |
| maintainer | |
| docs_url | None |
| author | Tomas Sladecek |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2022 Tomáš Sládeček 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.
|
<img src="docs/misc/logo-no-background.svg" width="100" alt="" style="float: right;">
# Create FastAPI App (cfa)
Create and manage FastAPI applications
## Quick Tour
Follow these steps to set up a FastAPI project. See the [documentation](https://tsladecek.github.io/create-fastapi-app/) for more details.
### Installation
This is a [pip package](https://pypi.org/project/create-fastapi-app/). Thus, the only thing you need to do, is to run:
```shell
pip install create-fastapi-app
```
### Usage
To create a new applications at a directory `~/my_fastapi_dir`, run:
```shell
cfa create ~/my_fastapi_dir
```
#### Options
##### Auth
You can choose from three auth setups:
- none - no auth (default)
- self - self-managed auth
```shell
cfa create ~/my_fastapi_dir --auth=self
```
Will create a `users` table and auth mechanisms for authorizing requests
- backend - auth managed by other backend
```shell
cfa create ~/my_fastapi_dir --auth=backend
```
Will create a logic for authorizing requests via external backend API. Remember to set the `BACKEND_URL` env var, as well as the `GET_USER_BY_TOKEN_ENDPOINT` env variable.
When trying to authorize, by default the app will call an endpoint at `http://{BACKEND_URL}/{GET_USER_BY_TOKEN_ENDPOINT}/{token}`. Make sure to have this endpoint and it returns a user object (with name, surname, email, etc)
Raw data
{
"_id": null,
"home_page": "",
"name": "create-fastapi-app",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Tomas Sladecek",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/fe/00/1fc8cf92753e55bc831d640753751a8fb28658c3336e4f3446552d2b7486/create-fastapi-app-0.4.4.tar.gz",
"platform": null,
"description": "<img src=\"docs/misc/logo-no-background.svg\" width=\"100\" alt=\"\" style=\"float: right;\">\n\n# Create FastAPI App (cfa)\n\n\nCreate and manage FastAPI applications\n\n## Quick Tour\n\nFollow these steps to set up a FastAPI project. See the [documentation](https://tsladecek.github.io/create-fastapi-app/) for more details.\n\n### Installation\n\nThis is a [pip package](https://pypi.org/project/create-fastapi-app/). Thus, the only thing you need to do, is to run:\n\n```shell\npip install create-fastapi-app\n```\n\n### Usage\n\nTo create a new applications at a directory `~/my_fastapi_dir`, run:\n\n```shell\ncfa create ~/my_fastapi_dir\n```\n\n#### Options\n\n##### Auth\n\nYou can choose from three auth setups:\n\n- none - no auth (default)\n- self - self-managed auth\n\n ```shell\n cfa create ~/my_fastapi_dir --auth=self\n ```\n\n Will create a `users` table and auth mechanisms for authorizing requests\n\n- backend - auth managed by other backend\n\n ```shell\n cfa create ~/my_fastapi_dir --auth=backend\n ```\n\n Will create a logic for authorizing requests via external backend API. Remember to set the `BACKEND_URL` env var, as well as the `GET_USER_BY_TOKEN_ENDPOINT` env variable.\n\n When trying to authorize, by default the app will call an endpoint at `http://{BACKEND_URL}/{GET_USER_BY_TOKEN_ENDPOINT}/{token}`. Make sure to have this endpoint and it returns a user object (with name, surname, email, etc)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Tom\u00e1\u0161 Sl\u00e1de\u010dek 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": "Wrapper for initializing FastAPI projects - Create Fastapi App",
"version": "0.4.4",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b957c01754b6527bd4ea3c99eb3dd7d73feafad519a8c830f5dffe91c2689556",
"md5": "2e42a0243ad1273d6da6ac134bfda885",
"sha256": "cdd8c15774d1f64349ad37b39df100dd09d172d562f2f3193ea0518aaec500cb"
},
"downloads": -1,
"filename": "create_fastapi_app-0.4.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e42a0243ad1273d6da6ac134bfda885",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 57590,
"upload_time": "2023-03-17T11:33:09",
"upload_time_iso_8601": "2023-03-17T11:33:09.223496Z",
"url": "https://files.pythonhosted.org/packages/b9/57/c01754b6527bd4ea3c99eb3dd7d73feafad519a8c830f5dffe91c2689556/create_fastapi_app-0.4.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe001fc8cf92753e55bc831d640753751a8fb28658c3336e4f3446552d2b7486",
"md5": "341fe62b8b9f154c8becb6889acce680",
"sha256": "a4f9f109e7f1b6a4aed7310c6450f9f1645531e0f4e4ea1b8162a1c1faab673a"
},
"downloads": -1,
"filename": "create-fastapi-app-0.4.4.tar.gz",
"has_sig": false,
"md5_digest": "341fe62b8b9f154c8becb6889acce680",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 47460,
"upload_time": "2023-03-17T11:33:10",
"upload_time_iso_8601": "2023-03-17T11:33:10.672340Z",
"url": "https://files.pythonhosted.org/packages/fe/00/1fc8cf92753e55bc831d640753751a8fb28658c3336e4f3446552d2b7486/create-fastapi-app-0.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-17 11:33:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "create-fastapi-app"
}
