fastapi-initializer 1.0.0__tar.gz → 1.0.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.
Files changed (8) hide show
  1. {fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/PKG-INFO +36 -16
  2. {fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/README.md +33 -13
  3. {fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/pyproject.toml +4 -2
  4. {fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/.gitignore +0 -0
  5. {fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/.python-version +0 -0
  6. {fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/LICENSE +0 -0
  7. {fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/main.py +0 -0
  8. {fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/uv.lock +0 -0
{fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/PKG-INFO RENAMED
@@ -1,14 +1,14 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: fastapi-initializer
3
- Version: 1.0.0
3
+ Version: 1.0.2
4
4
  Summary: An interactive CLI tool that scaffolds production-ready FastAPI projects with sensible defaults.
5
5
  Project-URL: Homepage, https://github.com/DasunNethsara-04/fastapi-initializer
6
6
  Project-URL: Repository, https://github.com/DasunNethsara-04/fastapi-initializer
7
7
  Project-URL: Issues, https://github.com/DasunNethsara-04/fastapi-initializer/issues
8
- Author-email: Dasun Nethsara <dasunnethsara04@gmail.com>
8
+ Author-email: Dasun Nethsara <techsaralk.pro@gmail.com>
9
9
  License: MIT
10
10
  License-File: LICENSE
11
- Keywords: boilerplate,cli,fastapi,initializer,project-generator,scaffold,template
11
+ Keywords: boilerplate,cli,fastapi,initializer,pipx,project-generator,scaffold,template,uv
12
12
  Classifier: Development Status :: 4 - Beta
13
13
  Classifier: Environment :: Console
14
14
  Classifier: Framework :: FastAPI
@@ -30,13 +30,11 @@ Description-Content-Type: text/markdown
30
30
 
31
31
  # FastAPI Initializer
32
32
 
33
- [![PyPI version](https://img.shields.io/pypi/v/fastapi-initializer.svg)](https://pypi.org/project/fastapi-initializer/)
34
- [![Python](https://img.shields.io/pypi/pyversions/fastapi-initializer.svg)](https://pypi.org/project/fastapi-initializer/)
35
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
33
+ [![PyPI version](https://img.shields.io/pypi/v/fastapi-initializer)](https://pypi.org/project/fastapi-initializer/)
34
+ [![Python](https://img.shields.io/pypi/pyversions/fastapi-initializer)](https://pypi.org/project/fastapi-initializer/)
35
+ [![License](https://img.shields.io/pypi/l/fastapi-initializer)](https://pypi.org/project/fastapi-initializer/)
36
36
 
37
- An interactive CLI tool that scaffolds **production-ready FastAPI projects** with sensible defaults — so you can skip the boilerplate and start building right away.
38
-
39
- ![fastapi-init demo](https://raw.githubusercontent.com/DasunNethsara-04/fastapi-initializer/main/assets/demo.gif)
37
+ An interactive CLI tool that scaffolds **production-ready FastAPI projects** with sensible defaults - so you can skip the boilerplate and start building right away.
40
38
 
41
39
  ---
42
40
 
@@ -57,16 +55,28 @@ Run a single command, answer a few prompts, and get a fully structured FastAPI p
57
55
 
58
56
  ## 📦 Installation
59
57
 
60
- ### Install from PyPI
58
+ ### Recommended: Install Globally
59
+
60
+ Install `fastapi-initializer` as a global CLI tool — no virtual environment needed. Just install once and use the `fastapi-init` command from anywhere, just like `uv`, `pip`, or `ruff`.
61
+
62
+ Using [pipx](https://pipx.pypa.io/):
61
63
 
62
64
  ```bash
63
- pip install fastapi-initializer
65
+ pipx install fastapi-initializer
64
66
  ```
65
67
 
66
- Or with [uv](https://docs.astral.sh/uv/):
68
+ Or using [uv](https://docs.astral.sh/uv/):
67
69
 
68
70
  ```bash
69
- uv pip install fastapi-initializer
71
+ uv tool install fastapi-initializer
72
+ ```
73
+
74
+ ### Alternative: Install with pip
75
+
76
+ If you prefer a traditional install inside a virtual environment:
77
+
78
+ ```bash
79
+ pip install fastapi-initializer
70
80
  ```
71
81
 
72
82
  ### Install from Source (for development)
@@ -127,6 +137,16 @@ Open **http://127.0.0.1:8000/docs** to see the interactive API docs.
127
137
 
128
138
  ---
129
139
 
140
+ ## Screenshorts
141
+ <img width="1115" height="626" alt="Screenshot 2026-02-27 163615" src="https://github.com/user-attachments/assets/2fea7d48-470f-4056-9ebf-d84b9bc3b259" />
142
+ <img width="1119" height="628" alt="Screenshot 2026-02-27 163832" src="https://github.com/user-attachments/assets/ec137440-6a73-49aa-8d24-651652724742" />
143
+ <img width="1107" height="618" alt="Screenshot 2026-02-27 163848" src="https://github.com/user-attachments/assets/b8500d30-f745-4a6d-8a15-04d33aef3bcd" />
144
+ <img width="1110" height="623" alt="Screenshot 2026-02-27 163910" src="https://github.com/user-attachments/assets/3bd33d4b-8ce1-4daa-accf-f5b2b0b5c66d" />
145
+ <img width="1916" height="1028" alt="Screenshot 2026-02-27 164031" src="https://github.com/user-attachments/assets/7414babe-42b5-42e7-ace2-c00d4b55e21b" />
146
+ <img width="302" height="988" alt="Screenshot 2026-02-27 164114" src="https://github.com/user-attachments/assets/3cbfbeba-fbb7-4445-ac2d-ea5a86c248fc" />
147
+
148
+ ---
149
+
130
150
  ## 📁 Generated Project Structure
131
151
 
132
152
  The generated project follows a modular, production-style layout:
@@ -220,6 +240,6 @@ This project is licensed under the [MIT License](LICENSE).
220
240
 
221
241
  Built with:
222
242
 
223
- - [FastAPI](https://fastapi.tiangolo.com/) — the framework this tool scaffolds
224
- - [Typer](https://typer.tiangolo.com/) — CLI framework
225
- - [InquirerPy](https://inquirerpy.readthedocs.io/) — interactive prompts
243
+ - [FastAPI](https://fastapi.tiangolo.com/) - the framework this tool scaffolds
244
+ - [Typer](https://typer.tiangolo.com/) - CLI framework
245
+ - [InquirerPy](https://inquirerpy.readthedocs.io/) - interactive prompts
{fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/README.md RENAMED
@@ -1,12 +1,10 @@
1
1
  # FastAPI Initializer
2
2
 
3
- [![PyPI version](https://img.shields.io/pypi/v/fastapi-initializer.svg)](https://pypi.org/project/fastapi-initializer/)
4
- [![Python](https://img.shields.io/pypi/pyversions/fastapi-initializer.svg)](https://pypi.org/project/fastapi-initializer/)
5
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
3
+ [![PyPI version](https://img.shields.io/pypi/v/fastapi-initializer)](https://pypi.org/project/fastapi-initializer/)
4
+ [![Python](https://img.shields.io/pypi/pyversions/fastapi-initializer)](https://pypi.org/project/fastapi-initializer/)
5
+ [![License](https://img.shields.io/pypi/l/fastapi-initializer)](https://pypi.org/project/fastapi-initializer/)
6
6
 
7
- An interactive CLI tool that scaffolds **production-ready FastAPI projects** with sensible defaults — so you can skip the boilerplate and start building right away.
8
-
9
- ![fastapi-init demo](https://raw.githubusercontent.com/DasunNethsara-04/fastapi-initializer/main/assets/demo.gif)
7
+ An interactive CLI tool that scaffolds **production-ready FastAPI projects** with sensible defaults - so you can skip the boilerplate and start building right away.
10
8
 
11
9
  ---
12
10
 
@@ -27,16 +25,28 @@ Run a single command, answer a few prompts, and get a fully structured FastAPI p
27
25
 
28
26
  ## 📦 Installation
29
27
 
30
- ### Install from PyPI
28
+ ### Recommended: Install Globally
29
+
30
+ Install `fastapi-initializer` as a global CLI tool — no virtual environment needed. Just install once and use the `fastapi-init` command from anywhere, just like `uv`, `pip`, or `ruff`.
31
+
32
+ Using [pipx](https://pipx.pypa.io/):
31
33
 
32
34
  ```bash
33
- pip install fastapi-initializer
35
+ pipx install fastapi-initializer
34
36
  ```
35
37
 
36
- Or with [uv](https://docs.astral.sh/uv/):
38
+ Or using [uv](https://docs.astral.sh/uv/):
37
39
 
38
40
  ```bash
39
- uv pip install fastapi-initializer
41
+ uv tool install fastapi-initializer
42
+ ```
43
+
44
+ ### Alternative: Install with pip
45
+
46
+ If you prefer a traditional install inside a virtual environment:
47
+
48
+ ```bash
49
+ pip install fastapi-initializer
40
50
  ```
41
51
 
42
52
  ### Install from Source (for development)
@@ -97,6 +107,16 @@ Open **http://127.0.0.1:8000/docs** to see the interactive API docs.
97
107
 
98
108
  ---
99
109
 
110
+ ## Screenshorts
111
+ <img width="1115" height="626" alt="Screenshot 2026-02-27 163615" src="https://github.com/user-attachments/assets/2fea7d48-470f-4056-9ebf-d84b9bc3b259" />
112
+ <img width="1119" height="628" alt="Screenshot 2026-02-27 163832" src="https://github.com/user-attachments/assets/ec137440-6a73-49aa-8d24-651652724742" />
113
+ <img width="1107" height="618" alt="Screenshot 2026-02-27 163848" src="https://github.com/user-attachments/assets/b8500d30-f745-4a6d-8a15-04d33aef3bcd" />
114
+ <img width="1110" height="623" alt="Screenshot 2026-02-27 163910" src="https://github.com/user-attachments/assets/3bd33d4b-8ce1-4daa-accf-f5b2b0b5c66d" />
115
+ <img width="1916" height="1028" alt="Screenshot 2026-02-27 164031" src="https://github.com/user-attachments/assets/7414babe-42b5-42e7-ace2-c00d4b55e21b" />
116
+ <img width="302" height="988" alt="Screenshot 2026-02-27 164114" src="https://github.com/user-attachments/assets/3cbfbeba-fbb7-4445-ac2d-ea5a86c248fc" />
117
+
118
+ ---
119
+
100
120
  ## 📁 Generated Project Structure
101
121
 
102
122
  The generated project follows a modular, production-style layout:
@@ -190,6 +210,6 @@ This project is licensed under the [MIT License](LICENSE).
190
210
 
191
211
  Built with:
192
212
 
193
- - [FastAPI](https://fastapi.tiangolo.com/) — the framework this tool scaffolds
194
- - [Typer](https://typer.tiangolo.com/) — CLI framework
195
- - [InquirerPy](https://inquirerpy.readthedocs.io/) — interactive prompts
213
+ - [FastAPI](https://fastapi.tiangolo.com/) - the framework this tool scaffolds
214
+ - [Typer](https://typer.tiangolo.com/) - CLI framework
215
+ - [InquirerPy](https://inquirerpy.readthedocs.io/) - interactive prompts
{fastapi_initializer-1.0.0 → fastapi_initializer-1.0.2}/pyproject.toml RENAMED
@@ -1,12 +1,12 @@
1
1
  [project]
2
2
  name = "fastapi-initializer"
3
- version = "1.0.0"
3
+ version = "1.0.2"
4
4
  description = "An interactive CLI tool that scaffolds production-ready FastAPI projects with sensible defaults."
5
5
  readme = "README.md"
6
6
  license = { text = "MIT" }
7
7
  requires-python = ">=3.10"
8
8
  authors = [
9
- { name = "Dasun Nethsara", email = "dasunnethsara04@gmail.com" },
9
+ { name = "Dasun Nethsara", email = "techsaralk.pro@gmail.com" },
10
10
  ]
11
11
  keywords = [
12
12
  "fastapi",
@@ -16,6 +16,8 @@ keywords = [
16
16
  "boilerplate",
17
17
  "initializer",
18
18
  "template",
19
+ "pipx",
20
+ "uv",
19
21
  ]
20
22
  classifiers = [
21
23
  "Development Status :: 4 - Beta",