Initial Folder framework and most of README done

Author: blevinscm

.gitignore

@@ -0,0 +1,148 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,
+
+#!! ERROR:  is undefined. Use list command to see defined gitignore types !!#
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+pytestdebug.log
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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/
+pythonenv*
+
+# 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/
+
+# profiling data
+.prof
+
+# End of https://www.toptal.com/developers/gitignore/api/python,
+nn

README.md

@@ -0,0 +1,57 @@
+FastAPI Base Scaffolding
+=============================================================================
+
+![GitHub](https://img.shields.io/github/license/blevinscm/fastapi-scaffold-base) ![GitHub contributors](https://img.shields.io/github/contributors/blevinscm/fastapi-scaffold-base) ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/blevinscm/fastapi-scaffold-base?include_prereleases)
+
+
+<img align="center" width="400" src="./images/fastapi-logo.png"/>
+
+#### Project Lead : | [Chris Blevins](https://github.com/blevinscm)
+
+Thanks to [Sebastián Ramírez @tiangolo](https://github.com/tiangolo) we have the wonderful FastAPI package for developing applications and APIs. Anyone looking at this repository is most likely familiar with the project.  If not I highly recommend Reading the Docs. 
+
+### [FastAPI](https://fastapi.tiangolo.com/)
+
+While learning and using FastAPI I have often needed/wanted lightweight project scaffolding.  The project generators and scaffolding projects in the FastAPI ecosystem have been either too deterministic and too big or not deterministic enough for me.  
+
+This uis how I set up a new FastAPI project.  I hope this is helpful. 
+
+## Dependencies: 
+
+  |Package | Note |
+  |:----|:------------|
+  |[Python 3.6+](https://www.python.org/downloads/) | This project uses Python 3.9 but should work on Python 3.6+. |
+  |[pip](https://pip.pypa.io/en/stable/installing/) | I use Pip for pacakage management and pin versions.  I don't think anything more complex than that is necessary.  Adjust for your flow. |
+  |[virtualenv](https://virtualenv.pypa.io/en/stable/installation.html) | Again I am not trying to get fancy.  ```py -m pip install virtualenv```|
+  |[FastAPI](https://github.com/tiangolo/fastapi) |  I usally install all related packages in my venv. ```pip install fastapi[all]```  |
+  |[Docker](https://www.docker.com/products/docker-desktop) | (Optional) I use it to startup DBs instead of installing directly. Will make your life easier. There are also images for bundled FastAPI environmets on Docker Hub.
+  |[ODMantic](https://art049.github.io/odmantic/) | ORM for MongoDB with great model and document support. |
+  |[TortoiseORM](https://tortoise-orm.readthedocs.io/en/latest/) | (Optional) ASYNC ORM that works well with FastAPI and Postgres/MySQL
+
+
+## Setup virtual environment (Windows)
+
+https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/
+
+1. Make sure venv is installed globally
+    ```bash
+    py -m pip install --user virtualenv
+    ```
+2. cd into workspace
+3. Create virtual environment
+    ```bash
+    py -m venv env
+    ```
+4. Activate virtual environment
+    ```bash
+    .\env\Scripts\activate
+    ```
+5. Install pip dependencies
+    ```bash
+    pip install -r requirements.txt
+    ```
+6. Now you can run the ```__main__.py``` script from a virtual context ```python lib```
+7. To get out of venv
+    ```bash
+    deactivate
+    ```