Code base

Adding project Code base

Author: anthonycepeda

.gitignore

@@ -0,0 +1,143 @@
+# author: https://github.com/github/gitignore/blob/master/Python.gitignore
+# IDE
+.vscode
+.pylintrc
+
+# 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/
+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/
+cover/
+
+# 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/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# 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/

FastAPI-MongoDB.png

@@ -0,0 +1,36 @@
+# usage: type in your terminal make run_tests_with_docker
+run_tests_with_docker:
+	docker build --pull --rm -f "./docker/Dockerfile.dev" -t api:latest "." && \
+	docker run -d p 8080:8080/tcp api:latest && \
+	pytest -v tavern_tests/test_*.tavern.yaml 
+
+run_pytest_venv:
+	# run pytest tavern api tests
+	# require .venv/ to exist: python3 -m venv .venv
+	. venv/bin/activate && \
+	pip install -r requirements/dev.txt && \
+	export ENVIRONMENT=DEV && \
+	export MONGODB_HOST="localhost:27017" && \
+	export MONGODB_DB_AUTH="admin" && \
+	nohup python entry_point.py > output.log & &&\
+	pytest -v tavern_tests/test_*.tavern.yaml 
+
+run_python_venv:
+	# run the api from python .venv 
+	# require .venv/ to exist: python3 -m venv .venv
+	. venv/bin/activate && \
+	pip install -r requirements/dev.txt && \
+	export ENVIRONMENT=DEV && \
+	export MONGODB_HOST="localhost:27017" && \
+	export MONGODB_DB_AUTH="admin" && \
+	python entry_point.py
+
+run_docker_dev:
+	# build and run from docker/Dockerfile.dev
+	docker build --pull --rm -f "./docker/Dockerfile.dev" -t api:latest "." && \
+	docker run --it p 8080:8080/tcp api:latest
+
+run_docker:
+	# build and run from docker/Dockerfile
+	docker build --pull --rm -f "./docker/Dockerfile" -t api:latest "." && \
+	docker run --it p 8080:8080/tcp api:latest

FastAPI-MongoDB_test.png

@@ -0,0 +1,50 @@
+# FastAPI MongoDB Async RestAPI
+
+### A Blueprint of a production-ready project.
+
+![alt text](./FastAPI-MongoDB.png)
+
+> This project is based on [Michaldev](https://github.com/michaldev)'s Github [fastapi-async-mongodb](https://github.com/michaldev/fastapi-async-mongodb).</br>
+> Headers, tokens and other security features has been ignored for simplicity.
+> How to setup a [local Mongodb](https://zellwk.com/blog/local-mongodb/) for testing purposes.
+
+# Features:
+
+- Framework: [Fastapi](https://github.com/tiangolo/fastapi)
+- DB: [MongoDB](https://github.com/mongodb/mongo)
+- dependencies:
+  - [Pydantic](https://github.com/samuelcolvin/pydantic)
+  - [Motor](https://github.com/mongodb/motor)
+  - [uvicorn](https://github.com/encode/uvicorn)
+  - [sentry](https://github.com/getsentry/sentry)
+  - [prometheus](https://github.com/prometheus/prometheus)
+  - [tavern](https://github.com/taverntesting/tavern)
+  - [Pytest](https://github.com/pytest-dev/pytest)
+
+## Usage:
+
+> Check ./Makefile content to understand how to run the app manually.
+
+- [Makefile](https://www.gnu.org/software/make/manual/html_node/Simple-Makefile.html):
+  - `make run_pytest_venv # run tests from a virtual environment (.venv)`
+  - `make run_docker_dev # create and run the api from ./docker/Dockerfile.dev`
+
+## Project Structure:
+
+```
+├───api
+│   ├───db          # db connection and mongodb api
+│   ├───models      # pydantic models
+│   ├───public      # public api namespaces
+│   │   ├───health  # health check
+│   │   └───user    # CRUD endpoints
+│   └───utils       # app utilities
+│   │   └───logger  # custom logger
+│   └───config.py   # app config
+│   └───main.py     # app main
+├───docker          # dockerfiles
+├───requirements    # dependencies
+└───tavern_tests    # api tests
+└───entry_point.py  # app entry point
+└───Makefile        # commands helper
+```

Makefile

@@ -0,0 +1,42 @@
+import os
+import secrets
+from functools import lru_cache
+from typing import Optional
+
+from pydantic import BaseSettings, HttpUrl
+
+
+def database_uri():
+    MONGODB_HOST = os.getenv("MONGODB_HOST", "localhost:27017")
+    MONGODB_DB_AUTH = os.getenv("MONGODB_DB_AUTH", "admin")
+    MONGODB_USERNAME = os.getenv("MONGODB_USERNAME")
+    MONGODB_PASSWORD = os.getenv("MONGODB_PASSWORD")
+
+    if os.getenv("ENVIRONMENT") != "DEV":
+        MONGODB_CLIENT_SETUP = f"mongodb://{MONGODB_USERNAME}:{MONGODB_PASSWORD}@{MONGODB_HOST}/{MONGODB_DB_AUTH}?tls=true"
+    else:
+        MONGODB_CLIENT_SETUP = f"mongodb://{MONGODB_HOST}/{MONGODB_DB_AUTH}?tls=false"
+    return MONGODB_CLIENT_SETUP
+
+
+class Settings(BaseSettings):
+    PROJECT_NAME: str = (
+        f"FastApi Mongo Async API - {os.getenv('ENVIRONMENT', 'DEV').capitalize()}"
+    )
+    VERSION: str = "v1.0.0"
+    DESCRIPTION: str = (
+        "A Production Ready FastAPI API using Asyncronous MongoDB Connection"
+    )
+    SECRET_KET: str = secrets.token_urlsafe(32)
+    SENTRY_DSN: Optional[HttpUrl] = os.getenv("SENTRY_DSN")
+    DEBUG: bool = bool(os.getenv("DEBUG", "False"))
+    ENVIRONMENT: str = os.getenv("ENVIRONMENT", "DEV").capitalize()
+    DB_URI = database_uri()
+
+    class Config:
+        case_sensitive = True
+
+
+@lru_cache
+def get_config():
+    return Settings()

README.md

@@ -0,0 +1,8 @@
+from api.db.database_manager import DatabaseManager
+from api.db.mongo_manager import MongoManager
+
+db = MongoManager()
+
+
+async def get_database() -> DatabaseManager:
+    return db

api/__init__.py

@@ -0,0 +1,57 @@
+from abc import abstractmethod
+from typing import List
+
+from api.models import User
+
+
+class DatabaseManager:
+    """
+    This class is meant to be extended from
+    ./mongo_manager.py which will be the actual connection to mongodb.
+    """
+
+    @property
+    def client(self):
+        raise NotImplementedError
+
+    @property
+    def db(self):
+        raise NotImplementedError
+
+    # database connect and close connections
+    @abstractmethod
+    async def connect_to_database(self, path: str):
+        pass
+
+    @abstractmethod
+    async def close_database_connection(self):
+        pass
+
+    # to be used from /api/public endpoints
+    @abstractmethod
+    async def user_get_total(self) -> int:
+        pass
+
+    @abstractmethod
+    async def user_get_actives(self) -> int:
+        pass
+
+    @abstractmethod
+    async def user_get_all(self) -> List[User]:
+        pass
+
+    @abstractmethod
+    async def user_get_one(self, user_id: str) -> List[User]:
+        pass
+
+    @abstractmethod
+    async def user_insert_one(self, user: User) -> List[User]:
+        pass
+
+    @abstractmethod
+    async def user_update_one(self, user: User) -> List[User]:
+        pass
+
+    @abstractmethod
+    async def user_delete_one(self, user: User) -> List[User]:
+        pass