shafikul-cli 2.0.0__tar.gz → 2.1.2__tar.gz
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.
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/LICENSE +20 -20
- {shafikul_cli-2.0.0/shafikul_cli.egg-info → shafikul_cli-2.1.2}/PKG-INFO +147 -147
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/README.md +129 -129
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/pyproject.toml +37 -37
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/setup.cfg +4 -4
- shafikul_cli-2.1.2/shafikul_cli/main.py +178 -0
- shafikul_cli-2.1.2/shafikul_cli/utility/create_file_content.py +77 -0
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli/utility/create_file_structure.py +25 -25
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli/utility/create_html_file.py +38 -38
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli/utility/ensure_db.py +55 -55
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli/utility/ensure_main.py +100 -100
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli/utility/env_generate.py +50 -50
- shafikul_cli-2.1.2/shafikul_cli/utility/helper_function.py +1858 -0
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli/utility/install_dependicy.py +70 -70
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2/shafikul_cli.egg-info}/PKG-INFO +147 -147
- shafikul_cli-2.0.0/shafikul_cli/main.py +0 -395
- shafikul_cli-2.0.0/shafikul_cli/utility/create_file_content.py +0 -46
- shafikul_cli-2.0.0/shafikul_cli/utility/helper_function.py +0 -1531
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli/__init__.py +0 -0
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli/asset/__init__.py +0 -0
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli/asset/logo.png +0 -0
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli/utility/__init__.py +0 -0
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli.egg-info/SOURCES.txt +0 -0
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli.egg-info/dependency_links.txt +0 -0
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli.egg-info/entry_points.txt +0 -0
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli.egg-info/requires.txt +0 -0
- {shafikul_cli-2.0.0 → shafikul_cli-2.1.2}/shafikul_cli.egg-info/top_level.txt +0 -0
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2026 Md Shafikul Islam
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Md Shafikul Islam
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
21
|
SOFTWARE.
|
|
@@ -1,147 +1,147 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: shafikul_cli
|
|
3
|
-
Version: 2.
|
|
4
|
-
Summary: CLI tool for FastAPI scaffolding with router, models, database, and templates.
|
|
5
|
-
Author-email: Md Shafikul Islam <buildwithshafikul@gmail.com>
|
|
6
|
-
Project-URL: Homepage, https://github.com/build-with-shafikul/shafikul_cli
|
|
7
|
-
Project-URL: Issues, https://github.com/build-with-shafikul/shafikul_cli/issues
|
|
8
|
-
Requires-Python: >=3.9
|
|
9
|
-
Description-Content-Type: text/markdown
|
|
10
|
-
License-File: LICENSE
|
|
11
|
-
Requires-Dist: typer
|
|
12
|
-
Requires-Dist: rich
|
|
13
|
-
Requires-Dist: keyboard
|
|
14
|
-
Requires-Dist: pyautogui
|
|
15
|
-
Requires-Dist: pyperclip
|
|
16
|
-
Dynamic: license-file
|
|
17
|
-
|
|
18
|
-
# Shafikul CLI
|
|
19
|
-
|
|
20
|
-
**Shafikul CLI** is a command-line tool to scaffold **FastAPI projects** quickly.
|
|
21
|
-
It helps you generate routers, models, database connections, HTML templates, full complete application with proper folder structure and auto updates for `main.py` and `.env` file.
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
## Features
|
|
26
|
-
|
|
27
|
-
- ✅ Create FastAPI routers, models, and database modules
|
|
28
|
-
- ✅ Auto-generate `main.py` with imports and DB setup
|
|
29
|
-
- ✅ Auto-generate or update `.env` file
|
|
30
|
-
- ✅ Create HTML templates (`index.html` or custom names)
|
|
31
|
-
- ✅ Interactive CLI (numeric and text options)
|
|
32
|
-
- ✅ Colored console output
|
|
33
|
-
- ✅ Version commands (`--version, -v, -V`)
|
|
34
|
-
- ✅ About commands (`--about, -a, -A`)
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
## Installation
|
|
39
|
-
|
|
40
|
-
Install from PyPI:
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
pip install shafikul_cli
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
Or Locally (editable):
|
|
47
|
-
```sh
|
|
48
|
-
git clone https://github.com/build-with-shafikul/shafikul_cli.git
|
|
49
|
-
cd shafikul_cli
|
|
50
|
-
pip install -e .
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
## CLI help
|
|
54
|
-
```sh
|
|
55
|
-
shafikul_cli --help
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
## Show version
|
|
59
|
-
```sh
|
|
60
|
-
shafikul_cli --version
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## About CLI
|
|
64
|
-
```sh
|
|
65
|
-
shafikul_cli --about
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
## Create resources
|
|
69
|
-
```sh
|
|
70
|
-
shafikul_cli create app
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
### Interactive Option
|
|
74
|
-
<code>
|
|
75
|
-
1: router <br/>
|
|
76
|
-
2: models <br/>
|
|
77
|
-
3: database <br/>
|
|
78
|
-
4: html <br/>
|
|
79
|
-
5: structure
|
|
80
|
-
</code>
|
|
81
|
-
<br/>
|
|
82
|
-
<br/>
|
|
83
|
-
|
|
84
|
-
You can select by number or by name
|
|
85
|
-
Example for HTML template: <br/>
|
|
86
|
-
<code>shafikul create app html <br/>
|
|
87
|
-
Enter file name default [index.html]: home.html</code>
|
|
88
|
-
|
|
89
|
-
Database creation also auto updates main.py and .env
|
|
90
|
-
|
|
91
|
-
# Project Structure
|
|
92
|
-
```sh
|
|
93
|
-
project_root/
|
|
94
|
-
│ .env
|
|
95
|
-
│ .gitignore
|
|
96
|
-
│ alembic.ini
|
|
97
|
-
│ main.py
|
|
98
|
-
│ README.md
|
|
99
|
-
│ requirements.txt
|
|
100
|
-
│ test.db
|
|
101
|
-
│
|
|
102
|
-
├───app
|
|
103
|
-
│ │ database.py
|
|
104
|
-
│ │ models.py
|
|
105
|
-
│
|
|
106
|
-
├───asset
|
|
107
|
-
│ ├───css
|
|
108
|
-
│ ├───images
|
|
109
|
-
│ └───js
|
|
110
|
-
├───migrations
|
|
111
|
-
│ │ env.py
|
|
112
|
-
│ │ README
|
|
113
|
-
│ │
|
|
114
|
-
│ ├───versions
|
|
115
|
-
│ │ │ b6bbf47f6a8a_create_users_table.py
|
|
116
|
-
│
|
|
117
|
-
├───router
|
|
118
|
-
│ users.py
|
|
119
|
-
│ __init__.py
|
|
120
|
-
│
|
|
121
|
-
├───static
|
|
122
|
-
│ └───images
|
|
123
|
-
│ logo.png
|
|
124
|
-
│
|
|
125
|
-
├───templates
|
|
126
|
-
│ index.html
|
|
127
|
-
│ notfound.html
|
|
128
|
-
│
|
|
129
|
-
└───utility
|
|
130
|
-
helper_function.py
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
# Development
|
|
134
|
-
|
|
135
|
-
If you want to contribute: <br/>
|
|
136
|
-
Fork the <a href="https://github.com/build-with-shafikul/shafikul_cli/fork">repo ↗</a> <br/>
|
|
137
|
-
Create a feature branch: git checkout -b feature-name<br/>
|
|
138
|
-
Commit your changes: git commit -m "Add feature"<br/>
|
|
139
|
-
Push to the branch: git push origin feature-name<br/>
|
|
140
|
-
Open a Pull Request
|
|
141
|
-
|
|
142
|
-
# License
|
|
143
|
-
`MIT License`
|
|
144
|
-
|
|
145
|
-
# Author
|
|
146
|
-
Md Shafikul Islam
|
|
147
|
-
<a href="https://github.com/build-with-shafikul" target="_blank">GitHub ↗</a>
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: shafikul_cli
|
|
3
|
+
Version: 2.1.2
|
|
4
|
+
Summary: CLI tool for FastAPI scaffolding with router, models, database, and templates.
|
|
5
|
+
Author-email: Md Shafikul Islam <buildwithshafikul@gmail.com>
|
|
6
|
+
Project-URL: Homepage, https://github.com/build-with-shafikul/shafikul_cli
|
|
7
|
+
Project-URL: Issues, https://github.com/build-with-shafikul/shafikul_cli/issues
|
|
8
|
+
Requires-Python: >=3.9
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Requires-Dist: typer
|
|
12
|
+
Requires-Dist: rich
|
|
13
|
+
Requires-Dist: keyboard
|
|
14
|
+
Requires-Dist: pyautogui
|
|
15
|
+
Requires-Dist: pyperclip
|
|
16
|
+
Dynamic: license-file
|
|
17
|
+
|
|
18
|
+
# Shafikul CLI
|
|
19
|
+
|
|
20
|
+
**Shafikul CLI** is a command-line tool to scaffold **FastAPI projects** quickly.
|
|
21
|
+
It helps you generate routers, models, database connections, HTML templates, full complete application with proper folder structure and auto updates for `main.py` and `.env` file.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## Features
|
|
26
|
+
|
|
27
|
+
- ✅ Create FastAPI routers, models, and database modules
|
|
28
|
+
- ✅ Auto-generate `main.py` with imports and DB setup
|
|
29
|
+
- ✅ Auto-generate or update `.env` file
|
|
30
|
+
- ✅ Create HTML templates (`index.html` or custom names)
|
|
31
|
+
- ✅ Interactive CLI (numeric and text options)
|
|
32
|
+
- ✅ Colored console output
|
|
33
|
+
- ✅ Version commands (`--version, -v, -V`)
|
|
34
|
+
- ✅ About commands (`--about, -a, -A`)
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Installation
|
|
39
|
+
|
|
40
|
+
Install from PyPI:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pip install shafikul_cli
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Or Locally (editable):
|
|
47
|
+
```sh
|
|
48
|
+
git clone https://github.com/build-with-shafikul/shafikul_cli.git
|
|
49
|
+
cd shafikul_cli
|
|
50
|
+
pip install -e .
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## CLI help
|
|
54
|
+
```sh
|
|
55
|
+
shafikul_cli --help
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Show version
|
|
59
|
+
```sh
|
|
60
|
+
shafikul_cli --version
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## About CLI
|
|
64
|
+
```sh
|
|
65
|
+
shafikul_cli --about
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Create resources
|
|
69
|
+
```sh
|
|
70
|
+
shafikul_cli create app
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Interactive Option
|
|
74
|
+
<code>
|
|
75
|
+
1: router <br/>
|
|
76
|
+
2: models <br/>
|
|
77
|
+
3: database <br/>
|
|
78
|
+
4: html <br/>
|
|
79
|
+
5: structure
|
|
80
|
+
</code>
|
|
81
|
+
<br/>
|
|
82
|
+
<br/>
|
|
83
|
+
|
|
84
|
+
You can select by number or by name
|
|
85
|
+
Example for HTML template: <br/>
|
|
86
|
+
<code>shafikul create app html <br/>
|
|
87
|
+
Enter file name default [index.html]: home.html</code>
|
|
88
|
+
|
|
89
|
+
Database creation also auto updates main.py and .env
|
|
90
|
+
|
|
91
|
+
# Project Structure
|
|
92
|
+
```sh
|
|
93
|
+
project_root/
|
|
94
|
+
│ .env
|
|
95
|
+
│ .gitignore
|
|
96
|
+
│ alembic.ini
|
|
97
|
+
│ main.py
|
|
98
|
+
│ README.md
|
|
99
|
+
│ requirements.txt
|
|
100
|
+
│ test.db
|
|
101
|
+
│
|
|
102
|
+
├───app
|
|
103
|
+
│ │ database.py
|
|
104
|
+
│ │ models.py
|
|
105
|
+
│
|
|
106
|
+
├───asset
|
|
107
|
+
│ ├───css
|
|
108
|
+
│ ├───images
|
|
109
|
+
│ └───js
|
|
110
|
+
├───migrations
|
|
111
|
+
│ │ env.py
|
|
112
|
+
│ │ README
|
|
113
|
+
│ │
|
|
114
|
+
│ ├───versions
|
|
115
|
+
│ │ │ b6bbf47f6a8a_create_users_table.py
|
|
116
|
+
│
|
|
117
|
+
├───router
|
|
118
|
+
│ users.py
|
|
119
|
+
│ __init__.py
|
|
120
|
+
│
|
|
121
|
+
├───static
|
|
122
|
+
│ └───images
|
|
123
|
+
│ logo.png
|
|
124
|
+
│
|
|
125
|
+
├───templates
|
|
126
|
+
│ index.html
|
|
127
|
+
│ notfound.html
|
|
128
|
+
│
|
|
129
|
+
└───utility
|
|
130
|
+
helper_function.py
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
# Development
|
|
134
|
+
|
|
135
|
+
If you want to contribute: <br/>
|
|
136
|
+
Fork the <a href="https://github.com/build-with-shafikul/shafikul_cli/fork">repo ↗</a> <br/>
|
|
137
|
+
Create a feature branch: git checkout -b feature-name<br/>
|
|
138
|
+
Commit your changes: git commit -m "Add feature"<br/>
|
|
139
|
+
Push to the branch: git push origin feature-name<br/>
|
|
140
|
+
Open a Pull Request
|
|
141
|
+
|
|
142
|
+
# License
|
|
143
|
+
`MIT License`
|
|
144
|
+
|
|
145
|
+
# Author
|
|
146
|
+
Md Shafikul Islam
|
|
147
|
+
<a href="https://github.com/build-with-shafikul" target="_blank">GitHub ↗</a>
|
|
@@ -1,130 +1,130 @@
|
|
|
1
|
-
# Shafikul CLI
|
|
2
|
-
|
|
3
|
-
**Shafikul CLI** is a command-line tool to scaffold **FastAPI projects** quickly.
|
|
4
|
-
It helps you generate routers, models, database connections, HTML templates, full complete application with proper folder structure and auto updates for `main.py` and `.env` file.
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Features
|
|
9
|
-
|
|
10
|
-
- ✅ Create FastAPI routers, models, and database modules
|
|
11
|
-
- ✅ Auto-generate `main.py` with imports and DB setup
|
|
12
|
-
- ✅ Auto-generate or update `.env` file
|
|
13
|
-
- ✅ Create HTML templates (`index.html` or custom names)
|
|
14
|
-
- ✅ Interactive CLI (numeric and text options)
|
|
15
|
-
- ✅ Colored console output
|
|
16
|
-
- ✅ Version commands (`--version, -v, -V`)
|
|
17
|
-
- ✅ About commands (`--about, -a, -A`)
|
|
18
|
-
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
## Installation
|
|
22
|
-
|
|
23
|
-
Install from PyPI:
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
pip install shafikul_cli
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
Or Locally (editable):
|
|
30
|
-
```sh
|
|
31
|
-
git clone https://github.com/build-with-shafikul/shafikul_cli.git
|
|
32
|
-
cd shafikul_cli
|
|
33
|
-
pip install -e .
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
## CLI help
|
|
37
|
-
```sh
|
|
38
|
-
shafikul_cli --help
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## Show version
|
|
42
|
-
```sh
|
|
43
|
-
shafikul_cli --version
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## About CLI
|
|
47
|
-
```sh
|
|
48
|
-
shafikul_cli --about
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
## Create resources
|
|
52
|
-
```sh
|
|
53
|
-
shafikul_cli create app
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
### Interactive Option
|
|
57
|
-
<code>
|
|
58
|
-
1: router <br/>
|
|
59
|
-
2: models <br/>
|
|
60
|
-
3: database <br/>
|
|
61
|
-
4: html <br/>
|
|
62
|
-
5: structure
|
|
63
|
-
</code>
|
|
64
|
-
<br/>
|
|
65
|
-
<br/>
|
|
66
|
-
|
|
67
|
-
You can select by number or by name
|
|
68
|
-
Example for HTML template: <br/>
|
|
69
|
-
<code>shafikul create app html <br/>
|
|
70
|
-
Enter file name default [index.html]: home.html</code>
|
|
71
|
-
|
|
72
|
-
Database creation also auto updates main.py and .env
|
|
73
|
-
|
|
74
|
-
# Project Structure
|
|
75
|
-
```sh
|
|
76
|
-
project_root/
|
|
77
|
-
│ .env
|
|
78
|
-
│ .gitignore
|
|
79
|
-
│ alembic.ini
|
|
80
|
-
│ main.py
|
|
81
|
-
│ README.md
|
|
82
|
-
│ requirements.txt
|
|
83
|
-
│ test.db
|
|
84
|
-
│
|
|
85
|
-
├───app
|
|
86
|
-
│ │ database.py
|
|
87
|
-
│ │ models.py
|
|
88
|
-
│
|
|
89
|
-
├───asset
|
|
90
|
-
│ ├───css
|
|
91
|
-
│ ├───images
|
|
92
|
-
│ └───js
|
|
93
|
-
├───migrations
|
|
94
|
-
│ │ env.py
|
|
95
|
-
│ │ README
|
|
96
|
-
│ │
|
|
97
|
-
│ ├───versions
|
|
98
|
-
│ │ │ b6bbf47f6a8a_create_users_table.py
|
|
99
|
-
│
|
|
100
|
-
├───router
|
|
101
|
-
│ users.py
|
|
102
|
-
│ __init__.py
|
|
103
|
-
│
|
|
104
|
-
├───static
|
|
105
|
-
│ └───images
|
|
106
|
-
│ logo.png
|
|
107
|
-
│
|
|
108
|
-
├───templates
|
|
109
|
-
│ index.html
|
|
110
|
-
│ notfound.html
|
|
111
|
-
│
|
|
112
|
-
└───utility
|
|
113
|
-
helper_function.py
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
# Development
|
|
117
|
-
|
|
118
|
-
If you want to contribute: <br/>
|
|
119
|
-
Fork the <a href="https://github.com/build-with-shafikul/shafikul_cli/fork">repo ↗</a> <br/>
|
|
120
|
-
Create a feature branch: git checkout -b feature-name<br/>
|
|
121
|
-
Commit your changes: git commit -m "Add feature"<br/>
|
|
122
|
-
Push to the branch: git push origin feature-name<br/>
|
|
123
|
-
Open a Pull Request
|
|
124
|
-
|
|
125
|
-
# License
|
|
126
|
-
`MIT License`
|
|
127
|
-
|
|
128
|
-
# Author
|
|
129
|
-
Md Shafikul Islam
|
|
1
|
+
# Shafikul CLI
|
|
2
|
+
|
|
3
|
+
**Shafikul CLI** is a command-line tool to scaffold **FastAPI projects** quickly.
|
|
4
|
+
It helps you generate routers, models, database connections, HTML templates, full complete application with proper folder structure and auto updates for `main.py` and `.env` file.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Features
|
|
9
|
+
|
|
10
|
+
- ✅ Create FastAPI routers, models, and database modules
|
|
11
|
+
- ✅ Auto-generate `main.py` with imports and DB setup
|
|
12
|
+
- ✅ Auto-generate or update `.env` file
|
|
13
|
+
- ✅ Create HTML templates (`index.html` or custom names)
|
|
14
|
+
- ✅ Interactive CLI (numeric and text options)
|
|
15
|
+
- ✅ Colored console output
|
|
16
|
+
- ✅ Version commands (`--version, -v, -V`)
|
|
17
|
+
- ✅ About commands (`--about, -a, -A`)
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Installation
|
|
22
|
+
|
|
23
|
+
Install from PyPI:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
pip install shafikul_cli
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Or Locally (editable):
|
|
30
|
+
```sh
|
|
31
|
+
git clone https://github.com/build-with-shafikul/shafikul_cli.git
|
|
32
|
+
cd shafikul_cli
|
|
33
|
+
pip install -e .
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## CLI help
|
|
37
|
+
```sh
|
|
38
|
+
shafikul_cli --help
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Show version
|
|
42
|
+
```sh
|
|
43
|
+
shafikul_cli --version
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## About CLI
|
|
47
|
+
```sh
|
|
48
|
+
shafikul_cli --about
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Create resources
|
|
52
|
+
```sh
|
|
53
|
+
shafikul_cli create app
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Interactive Option
|
|
57
|
+
<code>
|
|
58
|
+
1: router <br/>
|
|
59
|
+
2: models <br/>
|
|
60
|
+
3: database <br/>
|
|
61
|
+
4: html <br/>
|
|
62
|
+
5: structure
|
|
63
|
+
</code>
|
|
64
|
+
<br/>
|
|
65
|
+
<br/>
|
|
66
|
+
|
|
67
|
+
You can select by number or by name
|
|
68
|
+
Example for HTML template: <br/>
|
|
69
|
+
<code>shafikul create app html <br/>
|
|
70
|
+
Enter file name default [index.html]: home.html</code>
|
|
71
|
+
|
|
72
|
+
Database creation also auto updates main.py and .env
|
|
73
|
+
|
|
74
|
+
# Project Structure
|
|
75
|
+
```sh
|
|
76
|
+
project_root/
|
|
77
|
+
│ .env
|
|
78
|
+
│ .gitignore
|
|
79
|
+
│ alembic.ini
|
|
80
|
+
│ main.py
|
|
81
|
+
│ README.md
|
|
82
|
+
│ requirements.txt
|
|
83
|
+
│ test.db
|
|
84
|
+
│
|
|
85
|
+
├───app
|
|
86
|
+
│ │ database.py
|
|
87
|
+
│ │ models.py
|
|
88
|
+
│
|
|
89
|
+
├───asset
|
|
90
|
+
│ ├───css
|
|
91
|
+
│ ├───images
|
|
92
|
+
│ └───js
|
|
93
|
+
├───migrations
|
|
94
|
+
│ │ env.py
|
|
95
|
+
│ │ README
|
|
96
|
+
│ │
|
|
97
|
+
│ ├───versions
|
|
98
|
+
│ │ │ b6bbf47f6a8a_create_users_table.py
|
|
99
|
+
│
|
|
100
|
+
├───router
|
|
101
|
+
│ users.py
|
|
102
|
+
│ __init__.py
|
|
103
|
+
│
|
|
104
|
+
├───static
|
|
105
|
+
│ └───images
|
|
106
|
+
│ logo.png
|
|
107
|
+
│
|
|
108
|
+
├───templates
|
|
109
|
+
│ index.html
|
|
110
|
+
│ notfound.html
|
|
111
|
+
│
|
|
112
|
+
└───utility
|
|
113
|
+
helper_function.py
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
# Development
|
|
117
|
+
|
|
118
|
+
If you want to contribute: <br/>
|
|
119
|
+
Fork the <a href="https://github.com/build-with-shafikul/shafikul_cli/fork">repo ↗</a> <br/>
|
|
120
|
+
Create a feature branch: git checkout -b feature-name<br/>
|
|
121
|
+
Commit your changes: git commit -m "Add feature"<br/>
|
|
122
|
+
Push to the branch: git push origin feature-name<br/>
|
|
123
|
+
Open a Pull Request
|
|
124
|
+
|
|
125
|
+
# License
|
|
126
|
+
`MIT License`
|
|
127
|
+
|
|
128
|
+
# Author
|
|
129
|
+
Md Shafikul Islam
|
|
130
130
|
<a href="https://github.com/build-with-shafikul" target="_blank">GitHub ↗</a>
|
|
@@ -1,38 +1,38 @@
|
|
|
1
|
-
[build-system]
|
|
2
|
-
requires = ["setuptools>=61.0", "wheel"]
|
|
3
|
-
build-backend = "setuptools.build_meta"
|
|
4
|
-
|
|
5
|
-
[project]
|
|
6
|
-
name = "shafikul_cli"
|
|
7
|
-
version = "2.
|
|
8
|
-
description = "CLI tool for FastAPI scaffolding with router, models, database, and templates."
|
|
9
|
-
readme = "README.md"
|
|
10
|
-
requires-python = ">=3.9"
|
|
11
|
-
|
|
12
|
-
authors = [
|
|
13
|
-
{ name = "Md Shafikul Islam", email = "buildwithshafikul@gmail.com" }
|
|
14
|
-
]
|
|
15
|
-
|
|
16
|
-
dependencies = [
|
|
17
|
-
"typer",
|
|
18
|
-
"rich",
|
|
19
|
-
"keyboard",
|
|
20
|
-
"pyautogui",
|
|
21
|
-
"pyperclip"
|
|
22
|
-
]
|
|
23
|
-
|
|
24
|
-
[project.urls]
|
|
25
|
-
Homepage = "https://github.com/build-with-shafikul/shafikul_cli"
|
|
26
|
-
Issues = "https://github.com/build-with-shafikul/shafikul_cli/issues"
|
|
27
|
-
|
|
28
|
-
[project.scripts]
|
|
29
|
-
shafikul_cli = "shafikul_cli.main:app"
|
|
30
|
-
|
|
31
|
-
# 🔥 package auto detect
|
|
32
|
-
[tool.setuptools.packages.find]
|
|
33
|
-
where = ["."]
|
|
34
|
-
include = ["shafikul_cli*"]
|
|
35
|
-
|
|
36
|
-
# 🔥 asset include (VERY IMPORTANT)
|
|
37
|
-
[tool.setuptools.package-data]
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=61.0", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "shafikul_cli"
|
|
7
|
+
version = "2.1.2"
|
|
8
|
+
description = "CLI tool for FastAPI scaffolding with router, models, database, and templates."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.9"
|
|
11
|
+
|
|
12
|
+
authors = [
|
|
13
|
+
{ name = "Md Shafikul Islam", email = "buildwithshafikul@gmail.com" }
|
|
14
|
+
]
|
|
15
|
+
|
|
16
|
+
dependencies = [
|
|
17
|
+
"typer",
|
|
18
|
+
"rich",
|
|
19
|
+
"keyboard",
|
|
20
|
+
"pyautogui",
|
|
21
|
+
"pyperclip"
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
[project.urls]
|
|
25
|
+
Homepage = "https://github.com/build-with-shafikul/shafikul_cli"
|
|
26
|
+
Issues = "https://github.com/build-with-shafikul/shafikul_cli/issues"
|
|
27
|
+
|
|
28
|
+
[project.scripts]
|
|
29
|
+
shafikul_cli = "shafikul_cli.main:app"
|
|
30
|
+
|
|
31
|
+
# 🔥 package auto detect
|
|
32
|
+
[tool.setuptools.packages.find]
|
|
33
|
+
where = ["."]
|
|
34
|
+
include = ["shafikul_cli*"]
|
|
35
|
+
|
|
36
|
+
# 🔥 asset include (VERY IMPORTANT)
|
|
37
|
+
[tool.setuptools.package-data]
|
|
38
38
|
"shafikul_cli" = ["asset/*.png"]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[egg_info]
|
|
2
|
-
tag_build =
|
|
3
|
-
tag_date = 0
|
|
4
|
-
|
|
1
|
+
[egg_info]
|
|
2
|
+
tag_build =
|
|
3
|
+
tag_date = 0
|
|
4
|
+
|