FastAPI-fastkit 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- fastapi_fastkit/__init__.py +1 -1
- fastapi_fastkit-1.0.1.dist-info/METADATA +309 -0
- {fastapi_fastkit-1.0.0.dist-info → fastapi_fastkit-1.0.1.dist-info}/RECORD +6 -6
- {fastapi_fastkit-1.0.0.dist-info → fastapi_fastkit-1.0.1.dist-info}/WHEEL +1 -1
- fastapi_fastkit-1.0.0.dist-info/METADATA +0 -208
- {fastapi_fastkit-1.0.0.dist-info → fastapi_fastkit-1.0.1.dist-info}/entry_points.txt +0 -0
- {fastapi_fastkit-1.0.0.dist-info → fastapi_fastkit-1.0.1.dist-info}/licenses/LICENSE +0 -0
fastapi_fastkit/__init__.py
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
__version__ = 'v1.0.
|
|
1
|
+
__version__ = 'v1.0.1'
|
|
@@ -0,0 +1,309 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: FastAPI-fastkit
|
|
3
|
+
Version: 1.0.1
|
|
4
|
+
Summary: Fast, easy-to-use starter kit for new users of Python and FastAPI
|
|
5
|
+
Author-Email: bnbong <bbbong9@gmail.com>
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/bnbong/FastAPI-kit
|
|
8
|
+
Project-URL: Repository, https://github.com/bnbong/FastAPI-kit
|
|
9
|
+
Project-URL: Documentation, https://bnbong.github.io/FastAPI-fastkit/
|
|
10
|
+
Project-URL: Changelog, https://bnbong.github.io/FastAPI-fastkit/changelog/
|
|
11
|
+
Requires-Python: >=3.12
|
|
12
|
+
Requires-Dist: click>=8.1.7
|
|
13
|
+
Requires-Dist: rich>=13.9.2
|
|
14
|
+
Provides-Extra: dev
|
|
15
|
+
Requires-Dist: pytest>=8.3.3; extra == "dev"
|
|
16
|
+
Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
|
|
17
|
+
Requires-Dist: black>=24.10.0; extra == "dev"
|
|
18
|
+
Requires-Dist: pre-commit>=4.0.1; extra == "dev"
|
|
19
|
+
Requires-Dist: mypy>=1.12.0; extra == "dev"
|
|
20
|
+
Requires-Dist: isort>=5.13.2; extra == "dev"
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
|
|
23
|
+
<p align="center">
|
|
24
|
+
<img align="top" width="70%" src="https://bnbong.github.io/projects/img/fastkit_general_logo.png" alt="FastAPI-fastkit"/>
|
|
25
|
+
</p>
|
|
26
|
+
<p align="center">
|
|
27
|
+
<em><b>FastAPI-fastkit</b>: Fast, easy-to-use starter kit for new users of Python and FastAPI</em>
|
|
28
|
+
</p>
|
|
29
|
+
<p align="center">
|
|
30
|
+
<a href="https://pypi.org/project/fastapi-fastkit" target="_blank">
|
|
31
|
+
<img src="https://img.shields.io/pypi/v/fastapi-fastkit" alt="PyPI - Version">
|
|
32
|
+
</a>
|
|
33
|
+
<a href="https://github.com/bnbong/FastAPI-fastkit/releases" target="_blank">
|
|
34
|
+
<img src="https://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" alt="GitHub Release">
|
|
35
|
+
</a>
|
|
36
|
+
</p>
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
This project was created to speed up the configuration of the development environment needed to develop Python-based web apps for new users of Python and [FastAPI](https://github.com/fastapi/fastapi).
|
|
41
|
+
|
|
42
|
+
This project was inspired by the `SpringBoot initializer` & Python Django's `django-admin` cli operation.
|
|
43
|
+
|
|
44
|
+
## Key Features
|
|
45
|
+
|
|
46
|
+
- **Immediate FastAPI project creation** : Super-fast FastAPI workspace & project creation via CLI, inspired by `django-admin`feature of [Python Django](https://github.com/django/django)
|
|
47
|
+
- **Prettier CLI outputs** : beautiful CLI experiment ([rich library](https://github.com/Textualize/rich) feature)
|
|
48
|
+
- **Standards-based FastAPI project template** : All FastAPI-fastkit templates are based on Python standards and FastAPI's common use
|
|
49
|
+
|
|
50
|
+
## Installation
|
|
51
|
+
|
|
52
|
+
Install `FastAPI-fastkit` at your Python environment.
|
|
53
|
+
|
|
54
|
+
```console
|
|
55
|
+
$ pip install FastAPI-fastkit
|
|
56
|
+
---> 100%
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
## Usage
|
|
61
|
+
|
|
62
|
+
### Create a new FastAPI project workspace environment immediately
|
|
63
|
+
|
|
64
|
+
You can now start new FastAPI project really fast with FastAPI-fastkit!
|
|
65
|
+
|
|
66
|
+
Create a new FastAPI project workspace immediately with:
|
|
67
|
+
|
|
68
|
+
```console
|
|
69
|
+
$ fastkit init
|
|
70
|
+
Enter the project name: my-awesome-project
|
|
71
|
+
Enter the author name: John Doe
|
|
72
|
+
Enter the author email: john@example.com
|
|
73
|
+
Enter the project description: My awesome FastAPI project
|
|
74
|
+
|
|
75
|
+
Project Information
|
|
76
|
+
┌──────────────┬────────────────────────────┐
|
|
77
|
+
│ Project Name │ my-awesome-project │
|
|
78
|
+
│ Author │ John Doe │
|
|
79
|
+
│ Author Email │ john@example.com │
|
|
80
|
+
│ Description │ My awesome FastAPI project │
|
|
81
|
+
└──────────────┴────────────────────────────┘
|
|
82
|
+
|
|
83
|
+
Available Stacks and Dependencies:
|
|
84
|
+
MINIMAL Stack
|
|
85
|
+
┌──────────────┬───────────────────┐
|
|
86
|
+
│ Dependency 1 │ fastapi │
|
|
87
|
+
│ Dependency 2 │ uvicorn │
|
|
88
|
+
│ Dependency 3 │ pydantic │
|
|
89
|
+
│ Dependency 4 │ pydantic-settings │
|
|
90
|
+
└──────────────┴───────────────────┘
|
|
91
|
+
|
|
92
|
+
STANDARD Stack
|
|
93
|
+
┌──────────────┬───────────────────┐
|
|
94
|
+
│ Dependency 1 │ fastapi │
|
|
95
|
+
│ Dependency 2 │ uvicorn │
|
|
96
|
+
│ Dependency 3 │ sqlalchemy │
|
|
97
|
+
│ Dependency 4 │ alembic │
|
|
98
|
+
│ Dependency 5 │ pytest │
|
|
99
|
+
│ Dependency 6 │ pydantic │
|
|
100
|
+
│ Dependency 7 │ pydantic-settings │
|
|
101
|
+
└──────────────┴───────────────────┘
|
|
102
|
+
|
|
103
|
+
FULL Stack
|
|
104
|
+
┌──────────────┬───────────────────┐
|
|
105
|
+
│ Dependency 1 │ fastapi │
|
|
106
|
+
│ Dependency 2 │ uvicorn │
|
|
107
|
+
│ Dependency 3 │ sqlalchemy │
|
|
108
|
+
│ Dependency 4 │ alembic │
|
|
109
|
+
│ Dependency 5 │ pytest │
|
|
110
|
+
│ Dependency 6 │ redis │
|
|
111
|
+
│ Dependency 7 │ celery │
|
|
112
|
+
│ Dependency 8 │ pydantic │
|
|
113
|
+
│ Dependency 9 │ pydantic-settings │
|
|
114
|
+
└──────────────┴───────────────────┘
|
|
115
|
+
|
|
116
|
+
Select stack (minimal, standard, full): minimal
|
|
117
|
+
Do you want to proceed with project creation? [y/N]: y
|
|
118
|
+
FastAPI project will deploy at '~your-project-path~'
|
|
119
|
+
|
|
120
|
+
╭──────────────────────── Info ────────────────────────╮
|
|
121
|
+
│ ℹ Injected metadata into setup.py │
|
|
122
|
+
╰──────────────────────────────────────────────────────╯
|
|
123
|
+
╭──────────────────────── Info ────────────────────────╮
|
|
124
|
+
│ ℹ Injected metadata into config file │
|
|
125
|
+
╰──────────────────────────────────────────────────────╯
|
|
126
|
+
|
|
127
|
+
Creating Project:
|
|
128
|
+
my-awesome-project
|
|
129
|
+
┌───────────────────┬───────────┐
|
|
130
|
+
│ Component │ Collected │
|
|
131
|
+
│ fastapi │ ✓ │
|
|
132
|
+
│ uvicorn │ ✓ │
|
|
133
|
+
│ pydantic │ ✓ │
|
|
134
|
+
│ pydantic-settings │ ✓ │
|
|
135
|
+
└───────────────────┴───────────┘
|
|
136
|
+
|
|
137
|
+
Creating virtual environment...
|
|
138
|
+
|
|
139
|
+
╭──────────────────────── Info ────────────────────────╮
|
|
140
|
+
│ ℹ venv created at │
|
|
141
|
+
│ ~your-project-path~/my-awesome-project/.venv │
|
|
142
|
+
│ To activate the virtual environment, run: │
|
|
143
|
+
│ │
|
|
144
|
+
│ source │
|
|
145
|
+
│ ~your-project-path~/my-awesome-project/.venv/bin/act │
|
|
146
|
+
│ ivate │
|
|
147
|
+
╰──────────────────────────────────────────────────────╯
|
|
148
|
+
|
|
149
|
+
Installing dependencies...
|
|
150
|
+
⠙ Setting up project environment...Collecting <packages~>
|
|
151
|
+
|
|
152
|
+
---> 100%
|
|
153
|
+
|
|
154
|
+
╭─────────────────────── Success ───────────────────────╮
|
|
155
|
+
│ ✨ Dependencies installed successfully │
|
|
156
|
+
╰───────────────────────────────────────────────────────╯
|
|
157
|
+
╭─────────────────────── Success ───────────────────────╮
|
|
158
|
+
│ ✨ FastAPI project 'my-awesome-project' has been │
|
|
159
|
+
│ created successfully and saved to │
|
|
160
|
+
│ ~your-project-path~! │
|
|
161
|
+
╰───────────────────────────────────────────────────────╯
|
|
162
|
+
╭──────────────────────── Info ────────────────────────╮
|
|
163
|
+
│ ℹ To start your project, run 'fastkit runserver' at │
|
|
164
|
+
│ newly created FastAPI project directory │
|
|
165
|
+
╰──────────────────────────────────────────────────────╯
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
This command will create a new FastAPI project workspace environment with Python virtual environment.
|
|
169
|
+
|
|
170
|
+
### Add a new route to the FastAPI project
|
|
171
|
+
|
|
172
|
+
`FastAPI-fastkit` makes it easy to expand your FastAPI project.
|
|
173
|
+
|
|
174
|
+
Add a new route endpoint to your FastAPI project with:
|
|
175
|
+
|
|
176
|
+
```console
|
|
177
|
+
$ fastkit addroute my-awesome-project user
|
|
178
|
+
Adding New Route
|
|
179
|
+
┌──────────────────┬──────────────────────────────────────────┐
|
|
180
|
+
│ Project │ my-awesome-project │
|
|
181
|
+
│ Route Name │ user │
|
|
182
|
+
│ Target Directory │ ~your-project-path~ │
|
|
183
|
+
└──────────────────┴──────────────────────────────────────────┘
|
|
184
|
+
|
|
185
|
+
Do you want to add route 'user' to project 'my-awesome-project'? [Y/n]: y
|
|
186
|
+
|
|
187
|
+
╭──────────────────────── Info ────────────────────────╮
|
|
188
|
+
│ ℹ Updated main.py to include the API router │
|
|
189
|
+
╰──────────────────────────────────────────────────────╯
|
|
190
|
+
╭─────────────────────── Success ───────────────────────╮
|
|
191
|
+
│ ✨ Successfully added new route 'user' to project │
|
|
192
|
+
│ `my-awesome-project` │
|
|
193
|
+
╰───────────────────────────────────────────────────────╯
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Place a structured FastAPI demo project immediately
|
|
197
|
+
|
|
198
|
+
You can also start with a structured FastAPI demo project.
|
|
199
|
+
|
|
200
|
+
Demo projects are consist of various tech stacks with simple item CRUD endpoints implemented.
|
|
201
|
+
|
|
202
|
+
Place a structured FastAPI demo project immediately with:
|
|
203
|
+
|
|
204
|
+
```console
|
|
205
|
+
$ fastkit startdemo
|
|
206
|
+
Enter the project name: my-awesome-demo
|
|
207
|
+
Enter the author name: John Doe
|
|
208
|
+
Enter the author email: john@example.com
|
|
209
|
+
Enter the project description: My awesome FastAPI demo
|
|
210
|
+
Deploying FastAPI project using 'fastapi-default' template
|
|
211
|
+
Template path:
|
|
212
|
+
/~fastapi_fastkit-package-path~/fastapi_project_template/fastapi-default
|
|
213
|
+
|
|
214
|
+
Project Information
|
|
215
|
+
┌──────────────┬─────────────────────────┐
|
|
216
|
+
│ Project Name │ my-awesome-demo │
|
|
217
|
+
│ Author │ John Doe │
|
|
218
|
+
│ Author Email │ john@example.com │
|
|
219
|
+
│ Description │ My awesome FastAPI demo │
|
|
220
|
+
└──────────────┴─────────────────────────┘
|
|
221
|
+
|
|
222
|
+
Template Dependencies
|
|
223
|
+
┌──────────────┬───────────────────┐
|
|
224
|
+
│ Dependency 1 │ fastapi │
|
|
225
|
+
│ Dependency 2 │ uvicorn │
|
|
226
|
+
│ Dependency 3 │ pydantic │
|
|
227
|
+
│ Dependency 4 │ pydantic-settings │
|
|
228
|
+
│ Dependency 5 │ python-dotenv │
|
|
229
|
+
└──────────────┴───────────────────┘
|
|
230
|
+
|
|
231
|
+
Do you want to proceed with project creation? [y/N]: y
|
|
232
|
+
FastAPI template project will deploy at '~your-project-path~'
|
|
233
|
+
|
|
234
|
+
---> 100%
|
|
235
|
+
|
|
236
|
+
╭─────────────────────── Success ───────────────────────╮
|
|
237
|
+
│ ✨ Dependencies installed successfully │
|
|
238
|
+
╰───────────────────────────────────────────────────────╯
|
|
239
|
+
╭─────────────────────── Success ───────────────────────╮
|
|
240
|
+
│ ✨ FastAPI project 'my-awesome-demo' from │
|
|
241
|
+
│ 'fastapi-default' has been created and saved to │
|
|
242
|
+
│ ~your-project-path~! │
|
|
243
|
+
╰───────────────────────────────────────────────────────╯
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
To view the list of available FastAPI demos, check with:
|
|
247
|
+
|
|
248
|
+
```console
|
|
249
|
+
$ fastkit list-templates
|
|
250
|
+
Available Templates
|
|
251
|
+
┌─────────────────────────┬───────────────────────────────────┐
|
|
252
|
+
│ fastapi-custom-response │ Async Item Management API with │
|
|
253
|
+
│ │ Custom Response System │
|
|
254
|
+
│ fastapi-dockerized │ Dockerized FastAPI Item │
|
|
255
|
+
│ │ Management API │
|
|
256
|
+
│ fastapi-empty │ No description │
|
|
257
|
+
│ fastapi-async-crud │ Async Item Management API Server │
|
|
258
|
+
│ fastapi-psql-orm │ Dockerized FastAPI Item │
|
|
259
|
+
│ │ Management API with PostgreSQL │
|
|
260
|
+
│ fastapi-default │ Simple FastAPI Project │
|
|
261
|
+
└─────────────────────────┴───────────────────────────────────┘
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
## Contributing
|
|
265
|
+
|
|
266
|
+
We welcome contributions from the community! FastAPI-fastkit is designed to help newcomers to Python and FastAPI, and your contributions can make a significant impact.
|
|
267
|
+
|
|
268
|
+
### For Contributors
|
|
269
|
+
|
|
270
|
+
If you want to contribute to this project, we've made it easy to get started:
|
|
271
|
+
|
|
272
|
+
1. **Quick Development Setup:**
|
|
273
|
+
```bash
|
|
274
|
+
git clone https://github.com/bnbong/FastAPI-fastkit.git
|
|
275
|
+
cd FastAPI-fastkit
|
|
276
|
+
make dev-setup
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
2. **Available Development Commands:**
|
|
280
|
+
```bash
|
|
281
|
+
make help # See all available commands
|
|
282
|
+
make dev-check # Run all checks before submitting
|
|
283
|
+
make quick-test # Quick test after changes
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
3. **Read our contribution guidelines:**
|
|
287
|
+
- [CONTRIBUTING.md](CONTRIBUTING.md) - Detailed contribution guide
|
|
288
|
+
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - Project principles
|
|
289
|
+
- [SECURITY.md](SECURITY.md) - Security guidelines
|
|
290
|
+
|
|
291
|
+
### What You Can Contribute
|
|
292
|
+
|
|
293
|
+
- 🚀 **New FastAPI templates** - Add templates for different use cases
|
|
294
|
+
- 🐛 **Bug fixes** - Help us improve stability and reliability
|
|
295
|
+
- 📚 **Documentation** - Improve guides, examples, and translations
|
|
296
|
+
- 🧪 **Tests** - Increase test coverage and add integration tests
|
|
297
|
+
- 💡 **Features** - Suggest and implement new CLI features
|
|
298
|
+
|
|
299
|
+
## Significance of FastAPI-fastkit
|
|
300
|
+
|
|
301
|
+
FastAPI-fastkit aims to provide a fast and easy-to-use starter kit for new users of Python and FastAPI.
|
|
302
|
+
|
|
303
|
+
This idea was initiated with the aim of full fill to help FastAPI newcomers to learn from the beginning, which is the production significance of the FastAPI-cli package added with the [FastAPI 0.111.0 version update](https://github.com/fastapi/fastapi/releases/tag/0.111.0).
|
|
304
|
+
|
|
305
|
+
As one person who has been using and loving FastAPI for a long time, I wanted to develop a project that could help me a little bit to practice [the wonderful motivation](https://github.com/fastapi/fastapi/pull/11522#issuecomment-2264639417) that FastAPI developer [tiangolo](https://github.com/tiangolo) has.
|
|
306
|
+
|
|
307
|
+
## License
|
|
308
|
+
|
|
309
|
+
This project is licensed under the MIT License - see the [LICENSE](https://github.com/bnbong/FastAPI-fastkit/blob/main/LICENSE) file for details.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
fastapi_fastkit-1.0.
|
|
2
|
-
fastapi_fastkit-1.0.
|
|
3
|
-
fastapi_fastkit-1.0.
|
|
4
|
-
fastapi_fastkit-1.0.
|
|
5
|
-
fastapi_fastkit/__init__.py,sha256=
|
|
1
|
+
fastapi_fastkit-1.0.1.dist-info/METADATA,sha256=evzDqHUPcQ0Za8oSnbCmvYvRtc6cec-NGskIdifSnME,16349
|
|
2
|
+
fastapi_fastkit-1.0.1.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
|
|
3
|
+
fastapi_fastkit-1.0.1.dist-info/entry_points.txt,sha256=IONmgb7zWPnJWsCOcpF3u1yP6AWnPjrgWIv49mr1DZE,76
|
|
4
|
+
fastapi_fastkit-1.0.1.dist-info/licenses/LICENSE,sha256=2a9cYM3Uy8DW-so6zpYaqUafYT1Dznd3OCWCFe5CKNA,1066
|
|
5
|
+
fastapi_fastkit/__init__.py,sha256=6p2_N2LdNEx0s2rC1vd5LYuVCJ2ya740g-riPQhSMfQ,23
|
|
6
6
|
fastapi_fastkit/__main__.py,sha256=-FS9yUe4IEgDbJjFC1xso-pFCxRzUJ447j6bYpsBTBM,271
|
|
7
7
|
fastapi_fastkit/backend/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
8
8
|
fastapi_fastkit/backend/inspector.py,sha256=5KdFvRYdzZ4DWmC7hrPpMbrtHIf-Syh2qvSgK3HhjVo,7256
|
|
@@ -186,4 +186,4 @@ fastapi_fastkit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
|
186
186
|
fastapi_fastkit/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
187
187
|
fastapi_fastkit/utils/logging.py,sha256=l7wArbvgvakl2VEJrM51z3fp0I__qhaq8wU8SzLQY3I,1097
|
|
188
188
|
fastapi_fastkit/utils/main.py,sha256=hl8jfIxKpOr3jKW6ou9bBjhRKkETP-72fMRTFy45Nj0,4033
|
|
189
|
-
fastapi_fastkit-1.0.
|
|
189
|
+
fastapi_fastkit-1.0.1.dist-info/RECORD,,
|
|
@@ -1,208 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: FastAPI-fastkit
|
|
3
|
-
Version: 1.0.0
|
|
4
|
-
Summary: Fast, easy-to-use starter kit for new users of Python and FastAPI
|
|
5
|
-
Author-Email: bnbong <bbbong9@gmail.com>
|
|
6
|
-
License: MIT
|
|
7
|
-
Requires-Python: >=3.12
|
|
8
|
-
Requires-Dist: click>=8.1.7
|
|
9
|
-
Requires-Dist: rich>=13.9.2
|
|
10
|
-
Provides-Extra: dev
|
|
11
|
-
Requires-Dist: pytest>=8.3.3; extra == "dev"
|
|
12
|
-
Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
|
|
13
|
-
Requires-Dist: black>=24.10.0; extra == "dev"
|
|
14
|
-
Requires-Dist: pre-commit>=4.0.1; extra == "dev"
|
|
15
|
-
Requires-Dist: mypy>=1.12.0; extra == "dev"
|
|
16
|
-
Requires-Dist: isort>=5.13.2; extra == "dev"
|
|
17
|
-
Description-Content-Type: text/markdown
|
|
18
|
-
|
|
19
|
-
<p align="center">
|
|
20
|
-
<img align="top" width="70%" src="https://bnbong.github.io/projects/img/fastkit_general_logo.png" alt="FastAPI-fastkit"/>
|
|
21
|
-
</p>
|
|
22
|
-
<p align="center">
|
|
23
|
-
<em><b>FastAPI-fastkit</b>: Fast, easy-to-use starter kit for new users of Python and FastAPI</em>
|
|
24
|
-
</p>
|
|
25
|
-
<p align="center">
|
|
26
|
-
<a href="https://pypi.org/project/fastapi-fastkit" target="_blank">
|
|
27
|
-
<img src="https://img.shields.io/pypi/v/fastapi-fastkit" alt="PyPI - Version">
|
|
28
|
-
</a>
|
|
29
|
-
<a href="https://github.com/bnbong/FastAPI-fastkit/releases" target="_blank">
|
|
30
|
-
<img src="https://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" alt="GitHub Release">
|
|
31
|
-
</a>
|
|
32
|
-
</p>
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
This project was created to speed up the configuration of the development environment needed to develop Python-based web apps for new users of Python and [FastAPI](https://github.com/fastapi/fastapi).
|
|
37
|
-
|
|
38
|
-
This project was inspired by the `SpringBoot initializer` & Python Django's `django-admin` cli operation.
|
|
39
|
-
|
|
40
|
-
## Key Features
|
|
41
|
-
|
|
42
|
-
- **Immediate FastAPI project creation** : Super-fast FastAPI workspace & project creation via CLI, inspired by `django-admin`feature of [Python Django](https://github.com/django/django)
|
|
43
|
-
- **Prettier CLI outputs** : beautiful CLI experiment ([rich library](https://github.com/Textualize/rich) feature)
|
|
44
|
-
- **Standards-based FastAPI project template** : All FastAPI-fastkit templates are based on Python standards and FastAPI's common use
|
|
45
|
-
|
|
46
|
-
## Installation
|
|
47
|
-
|
|
48
|
-
Install `FastAPI-fastkit` at your Python environment.
|
|
49
|
-
|
|
50
|
-
```console
|
|
51
|
-
$ pip install FastAPI-fastkit
|
|
52
|
-
|
|
53
|
-
---> 100%
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
## Usage
|
|
57
|
-
|
|
58
|
-
### Create a new FastAPI project workspace environment immediately
|
|
59
|
-
|
|
60
|
-
You can now start new FastAPI project really fast with FastAPI-fastkit!
|
|
61
|
-
|
|
62
|
-
Create a new FastAPI project workspace immediately with:
|
|
63
|
-
|
|
64
|
-
```console
|
|
65
|
-
$ fastkit init
|
|
66
|
-
Enter the project name: <your-project-name>
|
|
67
|
-
Enter the author name: <your-name>
|
|
68
|
-
Enter the author email: <your-email>
|
|
69
|
-
Enter the project description: <your-project-description>
|
|
70
|
-
|
|
71
|
-
Available Stacks and Dependencies:
|
|
72
|
-
MINIMAL Stack
|
|
73
|
-
┌──────────────┬─────────┐
|
|
74
|
-
│ Dependency 1 │ fastapi │
|
|
75
|
-
│ Dependency 2 │ uvicorn │
|
|
76
|
-
└──────────────┴─────────┘
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
STANDARD Stack
|
|
80
|
-
┌──────────────┬────────────┐
|
|
81
|
-
│ Dependency 1 │ fastapi │
|
|
82
|
-
│ Dependency 2 │ uvicorn │
|
|
83
|
-
│ Dependency 3 │ sqlalchemy │
|
|
84
|
-
│ Dependency 4 │ alembic │
|
|
85
|
-
│ Dependency 5 │ pytest │
|
|
86
|
-
└──────────────┴────────────┘
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
FULL Stack
|
|
90
|
-
┌──────────────┬────────────────┐
|
|
91
|
-
│ Dependency 1 │ fastapi │
|
|
92
|
-
│ Dependency 2 │ uvicorn │
|
|
93
|
-
│ Dependency 3 │ sqlalchemy │
|
|
94
|
-
│ Dependency 4 │ alembic │
|
|
95
|
-
│ Dependency 5 │ pytest │
|
|
96
|
-
│ Dependency 6 │ redis │
|
|
97
|
-
│ Dependency 7 │ celery │
|
|
98
|
-
│ Dependency 8 │ docker-compose │
|
|
99
|
-
└──────────────┴────────────────┘
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
Select stack (minimal, standard, full): minimal
|
|
103
|
-
Creating Project:
|
|
104
|
-
new-fastapi-project
|
|
105
|
-
┌───────────┬────────┐
|
|
106
|
-
│ Component │ Status │
|
|
107
|
-
│ fastapi │ ✓ │
|
|
108
|
-
│ uvicorn │ ✓ │
|
|
109
|
-
└───────────┴────────┘
|
|
110
|
-
Creating virtual environment...
|
|
111
|
-
Installing dependencies...
|
|
112
|
-
⠙ Setting up project environment...Collecting <packages~>
|
|
113
|
-
|
|
114
|
-
---> 100%
|
|
115
|
-
|
|
116
|
-
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
117
|
-
│ ✨ Dependencies installed successfully │
|
|
118
|
-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
119
|
-
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
120
|
-
│ ✨ FastAPI project '<your-project-name>' has been created successfully and saved to '<your-project-path>'! │
|
|
121
|
-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
122
|
-
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
123
|
-
│ ℹ To start your project, run 'fastkit runserver' at newly created FastAPI project directory │
|
|
124
|
-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
This command will create a new FastAPI project workspace environment with Python virtual environment.
|
|
128
|
-
|
|
129
|
-
### Add a new route to the FastAPI project
|
|
130
|
-
|
|
131
|
-
`FastAPI-fastkit` makes it easy to expand your FastAPI project.
|
|
132
|
-
|
|
133
|
-
Add a new route endpoint to your FastAPI project with:
|
|
134
|
-
|
|
135
|
-
```console
|
|
136
|
-
$ fastkit addroute <your-project-name> <new-route-name>
|
|
137
|
-
|
|
138
|
-
---> 100%
|
|
139
|
-
|
|
140
|
-
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
141
|
-
│ ℹ Updated main.py to include the API router │
|
|
142
|
-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
143
|
-
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
144
|
-
│ ✨ Successfully added new route '<new-route-name>' to project '<your-project-name>'. │
|
|
145
|
-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
### Place a structured FastAPI demo project immediately
|
|
150
|
-
|
|
151
|
-
You can also start with a structured FastAPI demo project.
|
|
152
|
-
|
|
153
|
-
Demo projects are consist of various tech stacks with simple item CRUD endpoints implemented.
|
|
154
|
-
|
|
155
|
-
Place a structured FastAPI demo project immediately with:
|
|
156
|
-
|
|
157
|
-
```console
|
|
158
|
-
$ fastkit startdemo
|
|
159
|
-
Enter the project name: <your-project-name>
|
|
160
|
-
Enter the author name: <your-name>
|
|
161
|
-
Enter the author email: <your-email>
|
|
162
|
-
Enter the project description: <your-project-description>
|
|
163
|
-
Deploying FastAPI project using 'fastapi-default' template
|
|
164
|
-
Template path:
|
|
165
|
-
/<fastapi_fastkit-package-path>/fastapi_project_template/fastapi-defau
|
|
166
|
-
lt
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
Project Information
|
|
170
|
-
┌──────────────┬──────────────────────────────────────────┐
|
|
171
|
-
│ Project Name │ <your-project-name> │
|
|
172
|
-
│ Author │ <your-name> │
|
|
173
|
-
│ Author Email │ <your-email> │
|
|
174
|
-
│ Description │ <your-project-description> │
|
|
175
|
-
└──────────────┴──────────────────────────────────────────┘
|
|
176
|
-
|
|
177
|
-
Do you want to proceed with project creation? [y/N]: y
|
|
178
|
-
FastAPI template project will deploy at '<your-project-path>'
|
|
179
|
-
|
|
180
|
-
---> 100%
|
|
181
|
-
|
|
182
|
-
╭─────────────────────────────────────────────────────────────────── Success ────────────────────────────────────────────────────────────────────╮
|
|
183
|
-
│ ✨ FastAPI project '<your-project-name>' from 'fastapi-default' has been created and saved to │
|
|
184
|
-
│ <your-project-path>! │
|
|
185
|
-
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
To view the list of available FastAPI demos, check with:
|
|
189
|
-
|
|
190
|
-
```console
|
|
191
|
-
$ fastkit list-templates
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
## Significance of FastAPI-fastkit
|
|
195
|
-
|
|
196
|
-
FastAPI-fastkit aims to provide a fast and easy-to-use starter kit for new users of Python and FastAPI.
|
|
197
|
-
|
|
198
|
-
This idea was initiated with the aim of full fill to help FastAPI newcomers to learn from the beginning, which is the production significance of the FastAPI-cli package added with the [FastAPI 0.111.0 version update](https://github.com/fastapi/fastapi/releases/tag/0.111.0).
|
|
199
|
-
|
|
200
|
-
As one person who has been using and loving FastAPI for a long time, I wanted to develop a project that could help me a little bit to practice [the wonderful motivation](https://github.com/fastapi/fastapi/pull/11522#issuecomment-2264639417) that FastAPI developer [tiangolo](https://github.com/tiangolo) has.
|
|
201
|
-
|
|
202
|
-
## License
|
|
203
|
-
|
|
204
|
-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
205
|
-
|
|
206
|
-
---
|
|
207
|
-
|
|
208
|
-
@author bnbong bbbong9@gmail.com
|
|
File without changes
|
|
File without changes
|