feat: generated fastapi boilerplate with versioning and with folder structure.

Author: Jhanvi-vc

.gitignore

@@ -0,0 +1,267 @@
+# Project level files
+0.0.2
+alembic.ini
+changes_note.txt
+migrations/
+.dbdata/
+app.dp
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Backup files # 
+*.bak 
+
+# C extensions
+*.so
+
+# MacOS stuff
+**/.DS_Store
+
+# Docker ignore
+.dockerignore
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+flask_monitoringdashboard.db
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+*.pot
+*.pyc
+__pycache__
+db.sqlite3
+media
+
+#FastAPI stuff:
+.pytest_cache
+htmlcov
+dist
+site
+.coverage
+coverage.xml
+.netlify
+test.db
+log.txt
+docs_build
+docs.zip
+archive.zip
+
+
+# Flask stuff:
+# instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Python # 
+*.py[cod] 
+*$py.class 
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv/
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# If you are using PyCharm # 
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# File-based project format
+*.iws
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Distribution / packaging 
+.Python build/ 
+develop-eggs/ 
+dist/ 
+downloads/ 
+eggs/ 
+.eggs/ 
+lib/ 
+lib64/ 
+parts/ 
+sdist/ 
+var/ 
+wheels/ 
+*.egg-info/ 
+.installed.cfg 
+*.egg 
+*.manifest 
+*.spec 
+
+# Installer logs 
+pip-log.txt 
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports 
+htmlcov/ 
+.tox/ 
+.coverage
+.coverage.* 
+.cache 
+.pytest_cache/ 
+nosetests.xml 
+coverage.xml 
+*.cover 
+.hypothesis/ 
+
+# mkdocs documentation 
+/site 
+
+# mypy 
+.mypy_cache/ 
+
+# .key
+SECRET.key

README.md

@@ -0,0 +1,76 @@
+# NewsPicking-Backend
+
+## 🛠 Skills
+Python, Fask-API, Swagger Doc, Html and Java Scripts.
+
+## Install + configure the project
+
+### 1. Linux
+```
+# Create python virtual environment
+python3 -m venv venv
+
+# Activate the python virtual environment
+source venv/bin/activate
+
+# Install the requirements for the project into the virtual environment
+pip install -r requirements.txt
+
+# Install the dependencies of Fast API
+pip install "fastapi[all]"
+
+# Upgrade pip version
+python -m pip install --upgrade pip==22.1.2
+```
+### 2. Windows
+```
+# Create python virtual environment
+conda create --name venv python=3.10.12
+
+# Activate the python virtual environment
+conda activate venv
+
+# Install the requirements for the project into the virtual environment in the following sequence:
+pip install -r requirements.txt
+
+# Install the dependencies of Fast API
+pip install "fastapi[all]"
+
+# Upgrade pip version
+python -m pip install --upgrade pip==22.1.2
+```
+
+## Use the alembic to Upgrade/Downgrade the database in the FastAPI
+Note: Because by default Fastapi is provide only initial migrations. It doesn't support the upgrade and downgrade the database.
+so,to perform automatic migrations follow the following steps:
+
+1. # To create Migration folder
+python -m alembic init migrations
+
+2. ## update the Migrations>>env.py file o auto migrate the database.
+from models import Base
+target_database = Base.metadata
+
+4. # Perform the initial migrations
+alembic revision --autogenerate -m 'initials'
+
+5. # Apply the changes into the database (upgrade the database)
+alembic upgrade head
+   # To downgrade the database if required
+   alembic downgrade -1
+
+## Run the server in development mode
+ 
+Add environment variables (given in .env) by running following command in cmd/terminal:
+
+Run the server
+```
+python asgi.py
+```
+Browse Swagger API Doc at: http://localhost:8000/docs
+Browse  Redoc at: http://localhost:8000/redoc
+
+## Release History
+
+* 0.1
+    * Work in progress

apps/__init__.py

@@ -0,0 +1,16 @@
+from fastapi import FastAPI
+from fastapi_versioning import VersionedFastAPI
+
+from apps.api.auth.v1.view import router
+from apps.api.auth.v2.view import authrouter
+from config import cors
+
+# Create app object and add routes
+app = FastAPI(title="Python FastAPI boilerplate", middleware=cors.middleware)
+
+# define router for different version
+app.include_router(router, prefix="/v1", tags=["v1"]) # router for version 1
+app.include_router(authrouter, prefix="/v2", tags=["v2"]) # router for version 2
+
+# # # Define version to specify version related API's.
+app = VersionedFastAPI(app, version_format="{major}", prefix_format="/v{major}", enable_latest=True)

apps/api/auth/method.py

@@ -0,0 +1,15 @@
+from apps.utils.standard_response import StandardResponse
+from fastapi import status
+from apps.constant import constant
+
+def get_str_name(name: str):
+    if name is not None:
+        return StandardResponse(
+            True, status.HTTP_200_OK, {"success": "Welcome"}, 
+            constant.STATUS_SUCCESS
+            )
+    else:
+        return StandardResponse(
+            True, status.HTTP_400_BAD_REQUEST, {"success": "Error"}, 
+            constant.STATUS_ERROR
+            )