fastbrick 0.3__py3-none-any.whl → 0.5__py3-none-any.whl

{fastbrick-0.3.dist-info → fastbrick-0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastbrick
-Version: 0.3
+Version: 0.5
 Summary: A CLI tool for generating FastAPI projects and apps
 Home-page: UNKNOWN
 Author: Sandeep Singh Negi
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
-Description-Content-Type: text/plain
+Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: click
 Requires-Dist: fastapi
@@ -35,22 +35,41 @@ Start the FastAPI server with:
 uvicorn main:app --reload
 ```
 
+## Help Command
+
+To see available options and commands:
+```sh
+fastbrick --help
+```
+
+## Usage
+Create a New Project
+Creates a new FastAPI project with a structured layout.
+```sh
+fastbrick create-project my_project
+```
+Create a New App
+Creates a new FastAPI app (router) with database settings.
+
+```sh
+fastbirck create-app my_app
+```
+
 ## Project Structure
 
 ```
 myproject/
 │── main.py          # Entry point for FastAPI app
-│── routes.py        # Contains 'custom_routes'
-│── alembic.ini
+│── routes.py        # Contains 'app routes'
 │── models.py
 │── schemas.py
 │── middlewares/
 │   ├── middleware.py  # Global middleware logic
 │── routers/         # API route modules
 │── settings/
+│   ├── config.py  # Database configuration
 │   ├── database.py  # Database configuration
 │   ├── routing.py   # Router configurations
-│── alembic/
 ```
 
 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.dist-info/RECORD

@@ -0,0 +1,6 @@
+fastbrick-0.5.dist-info/LICENSE,sha256=VueWmlho5XxqjRpByo5KlMuWT7T-_AjQOVeiXRad66o,244
+fastbrick-0.5.dist-info/METADATA,sha256=OF9uXjjH_6oa7p_DGuVU_XTXwTCFFlwGuP0kZV3aWo0,1749
+fastbrick-0.5.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+fastbrick-0.5.dist-info/entry_points.txt,sha256=E25qyIpsqpZCjdza4bncHZhd7tmQwWqnWaz8eTz5luE,45
+fastbrick-0.5.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+fastbrick-0.5.dist-info/RECORD,,

fastbrick-0.5.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+fastbrick = fastbrick:cli
+

fastbrick-0.3.dist-info/RECORD

@@ -1,6 +0,0 @@
-fastbrick-0.3.dist-info/LICENSE,sha256=VueWmlho5XxqjRpByo5KlMuWT7T-_AjQOVeiXRad66o,244
-fastbrick-0.3.dist-info/METADATA,sha256=RKVDqXq5lqM6ht-Ugqku-WSulBpW_peq9JcZOEFX1bA,1406
-fastbrick-0.3.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-fastbrick-0.3.dist-info/entry_points.txt,sha256=PdmQx7gBRECxTrnA3YwBPlXsiGKDsiJOaZCaJQo_HPE,47
-fastbrick-0.3.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-fastbrick-0.3.dist-info/RECORD,,

fastbrick-0.3.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-fastbrick = fastapi_cli:cli
-