fastbrick 0.3__tar.gz → 0.5__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 (12) hide show
  1. {fastbrick-0.3 → fastbrick-0.5}/PKG-INFO +24 -5
  2. {fastbrick-0.3 → fastbrick-0.5}/README.md +22 -3
  3. {fastbrick-0.3 → fastbrick-0.5}/fastbrick.egg-info/PKG-INFO +24 -5
  4. fastbrick-0.5/fastbrick.egg-info/entry_points.txt +3 -0
  5. {fastbrick-0.3 → fastbrick-0.5}/setup.py +3 -3
  6. fastbrick-0.3/fastbrick.egg-info/entry_points.txt +0 -3
  7. {fastbrick-0.3 → fastbrick-0.5}/LICENSE +0 -0
  8. {fastbrick-0.3 → fastbrick-0.5}/fastbrick.egg-info/SOURCES.txt +0 -0
  9. {fastbrick-0.3 → fastbrick-0.5}/fastbrick.egg-info/dependency_links.txt +0 -0
  10. {fastbrick-0.3 → fastbrick-0.5}/fastbrick.egg-info/requires.txt +0 -0
  11. {fastbrick-0.3 → fastbrick-0.5}/fastbrick.egg-info/top_level.txt +0 -0
  12. {fastbrick-0.3 → fastbrick-0.5}/setup.cfg +0 -0
{fastbrick-0.3 → fastbrick-0.5}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: fastbrick
3
- Version: 0.3
3
+ Version: 0.5
4
4
  Summary: A CLI tool for generating FastAPI projects and apps
5
5
  Home-page: UNKNOWN
6
6
  Author: Sandeep Singh Negi
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3
11
11
  Classifier: License :: OSI Approved :: MIT License
12
12
  Classifier: Operating System :: OS Independent
13
13
  Requires-Python: >=3.7
14
- Description-Content-Type: text/plain
14
+ Description-Content-Type: text/markdown
15
15
  License-File: LICENSE
16
16
 
17
17
  # FastBrick 🚀
@@ -32,22 +32,41 @@ Start the FastAPI server with:
32
32
  uvicorn main:app --reload
33
33
  ```
34
34
 
35
+ ## Help Command
36
+
37
+ To see available options and commands:
38
+ ```sh
39
+ fastbrick --help
40
+ ```
41
+
42
+ ## Usage
43
+ Create a New Project
44
+ Creates a new FastAPI project with a structured layout.
45
+ ```sh
46
+ fastbrick create-project my_project
47
+ ```
48
+ Create a New App
49
+ Creates a new FastAPI app (router) with database settings.
50
+
51
+ ```sh
52
+ fastbirck create-app my_app
53
+ ```
54
+
35
55
  ## Project Structure
36
56
 
37
57
  ```
38
58
  myproject/
39
59
  │── main.py # Entry point for FastAPI app
40
- │── routes.py # Contains 'custom_routes'
41
- │── alembic.ini
60
+ │── routes.py # Contains 'app routes'
42
61
  │── models.py
43
62
  │── schemas.py
44
63
  │── middlewares/
45
64
  │ ├── middleware.py # Global middleware logic
46
65
  │── routers/ # API route modules
47
66
  │── settings/
67
+ │ ├── config.py # Database configuration
48
68
  │ ├── database.py # Database configuration
49
69
  │ ├── routing.py # Router configurations
50
- │── alembic/
51
70
  ```
52
71
 
53
72
  This structure ensures modularity and scalability for your FastAPI project. Adjust the folders and files as needed based on your project requirements.
{fastbrick-0.3 → fastbrick-0.5}/README.md RENAMED
@@ -16,22 +16,41 @@ Start the FastAPI server with:
16
16
  uvicorn main:app --reload
17
17
  ```
18
18
 
19
+ ## Help Command
20
+
21
+ To see available options and commands:
22
+ ```sh
23
+ fastbrick --help
24
+ ```
25
+
26
+ ## Usage
27
+ Create a New Project
28
+ Creates a new FastAPI project with a structured layout.
29
+ ```sh
30
+ fastbrick create-project my_project
31
+ ```
32
+ Create a New App
33
+ Creates a new FastAPI app (router) with database settings.
34
+
35
+ ```sh
36
+ fastbirck create-app my_app
37
+ ```
38
+
19
39
  ## Project Structure
20
40
 
21
41
  ```
22
42
  myproject/
23
43
  │── main.py # Entry point for FastAPI app
24
- │── routes.py # Contains 'custom_routes'
25
- │── alembic.ini
44
+ │── routes.py # Contains 'app routes'
26
45
  │── models.py
27
46
  │── schemas.py
28
47
  │── middlewares/
29
48
  │ ├── middleware.py # Global middleware logic
30
49
  │── routers/ # API route modules
31
50
  │── settings/
51
+ │ ├── config.py # Database configuration
32
52
  │ ├── database.py # Database configuration
33
53
  │ ├── routing.py # Router configurations
34
- │── alembic/
35
54
  ```
36
55
 
37
56
  This structure ensures modularity and scalability for your FastAPI project. Adjust the folders and files as needed based on your project requirements.
{fastbrick-0.3 → fastbrick-0.5}/fastbrick.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: fastbrick
3
- Version: 0.3
3
+ Version: 0.5
4
4
  Summary: A CLI tool for generating FastAPI projects and apps
5
5
  Home-page: UNKNOWN
6
6
  Author: Sandeep Singh Negi
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3
11
11
  Classifier: License :: OSI Approved :: MIT License
12
12
  Classifier: Operating System :: OS Independent
13
13
  Requires-Python: >=3.7
14
- Description-Content-Type: text/plain
14
+ Description-Content-Type: text/markdown
15
15
  License-File: LICENSE
16
16
 
17
17
  # FastBrick 🚀
@@ -32,22 +32,41 @@ Start the FastAPI server with:
32
32
  uvicorn main:app --reload
33
33
  ```
34
34
 
35
+ ## Help Command
36
+
37
+ To see available options and commands:
38
+ ```sh
39
+ fastbrick --help
40
+ ```
41
+
42
+ ## Usage
43
+ Create a New Project
44
+ Creates a new FastAPI project with a structured layout.
45
+ ```sh
46
+ fastbrick create-project my_project
47
+ ```
48
+ Create a New App
49
+ Creates a new FastAPI app (router) with database settings.
50
+
51
+ ```sh
52
+ fastbirck create-app my_app
53
+ ```
54
+
35
55
  ## Project Structure
36
56
 
37
57
  ```
38
58
  myproject/
39
59
  │── main.py # Entry point for FastAPI app
40
- │── routes.py # Contains 'custom_routes'
41
- │── alembic.ini
60
+ │── routes.py # Contains 'app routes'
42
61
  │── models.py
43
62
  │── schemas.py
44
63
  │── middlewares/
45
64
  │ ├── middleware.py # Global middleware logic
46
65
  │── routers/ # API route modules
47
66
  │── settings/
67
+ │ ├── config.py # Database configuration
48
68
  │ ├── database.py # Database configuration
49
69
  │ ├── routing.py # Router configurations
50
- │── alembic/
51
70
  ```
52
71
 
53
72
  This structure ensures modularity and scalability for your FastAPI project. Adjust the folders and files as needed based on your project requirements.
fastbrick-0.5/fastbrick.egg-info/entry_points.txt ADDED
@@ -0,0 +1,3 @@
1
+ [console_scripts]
2
+ fastbrick = fastbrick:cli
3
+
{fastbrick-0.3 → fastbrick-0.5}/setup.py RENAMED
@@ -7,17 +7,17 @@ with open("README.md", "r", encoding="utf-8") as fh:
7
7
 
8
8
  setup(
9
9
  name="fastbrick",
10
- version="0.3",
10
+ version="0.5",
11
11
  author="Sandeep Singh Negi", # 👈
12
12
  author_email="sandeepnegi1710@gmail.com", # 👈
13
13
  description="A CLI tool for generating FastAPI projects and apps",
14
14
  long_description=long_description, # Use the README content
15
- long_description_content_type="text/plain",
15
+ long_description_content_type="text/markdown",
16
16
  packages=find_packages(),
17
17
  install_requires=["fastapi", "click", "jinja2"],
18
18
  entry_points={
19
19
  "console_scripts": [
20
- "fastbrick = fastapi_cli:cli",
20
+ "fastbrick = fastbrick:cli",
21
21
  ],
22
22
  },
23
23
  classifiers=[
fastbrick-0.3/fastbrick.egg-info/entry_points.txt DELETED
@@ -1,3 +0,0 @@
1
- [console_scripts]
2
- fastbrick = fastapi_cli:cli
3
-
{fastbrick-0.3 → fastbrick-0.5}/LICENSE RENAMED
File without changes
{fastbrick-0.3 → fastbrick-0.5}/setup.cfg RENAMED
File without changes