Skip to content

Commit 575f555

Browse files
committed
[ADD, TEMPLATE] edit core cli operations, refactored backend module, add fastapi-empty, module template
1 parent 4619d13 commit 575f555

File tree

26 files changed

+1040
-137
lines changed

26 files changed

+1040
-137
lines changed

README.md

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,11 @@ $ pip install FastAPI-fastkit
4242
Create a new FastAPI project workspace with:
4343

4444
```console
45-
$ fastkit startproject
46-
Enter project name: <your-project-name>
45+
$ fastkit init
46+
Enter the project name: <your-project-name>
47+
Enter the author name: <your-name>
48+
Enter the author email: <your-email>
49+
Enter the project description: <your-project-description>
4750

4851
Available Stacks and Dependencies:
4952
MINIMAL Stack
@@ -98,16 +101,43 @@ Installing dependencies...
98101
│ │
99102
│ source /<new-venv-path>/venv/bin/activate │
100103
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
104+
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
105+
│ ✨ Dependencies installed successfully │
106+
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
107+
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
108+
│ ✨ FastAPI project '<your-project-name>' has been created successfully and saved to '<your-project-path>'! │
109+
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
110+
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
111+
│ ℹ To start your project, run 'fastkit runserver' at newly created FastAPI project directory │
112+
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
101113
```
102114

103115
This command will create a new FastAPI project workspace environment with Python virtual environment.
104116

117+
### Add a new route to the FastAPI project
118+
119+
Add a new route to the FastAPI project with:
120+
121+
```console
122+
$ fastkit addroute <your-project-name> <new-route-name>
123+
124+
---> 100%
125+
126+
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
127+
│ ℹ Updated main.py to include the API router │
128+
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
129+
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
130+
│ ✨ Successfully added new route '<new-route-name>' to project '<your-project-name>'. │
131+
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
132+
```
133+
134+
105135
### Place a structured FastAPI project immediately
106136

107-
Place a structured FastAPI project immediately with:
137+
Place a structured FastAPI demo project immediately with:
108138

109139
```console
110-
$ fastkit startup
140+
$ fastkit startdemo
111141
Enter the project name: <your-project-name>
112142
Enter the author name: <your-name>
113143
Enter the author email: <your-email>

src/fastapi_fastkit/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
__version__ = "0.1.3"
1+
__version__ = "0.1.4"
22

33
import os
44

0 commit comments

Comments
 (0)