worflow files for staging, dev and prod

.env.sample

@@ -1,12 +1,12 @@
 PYTHON_ENV=dev
-DB_TYPE=mysql
+DB_TYPE=postgresql
 DB_NAME=dbname
 DB_USER=user
 DB_PASSWORD=password
 DB_HOST=127.0.0.1
-DB_PORT=3306
-MYSQL_DRIVER=pymysql
-DB_URL="mysql+pymysql://user:[email protected]:3306/dbname"
+DB_PORT=5432
+MYSQL_DRIVER=pymysql 
+DB_URL="postgresql://user:[email protected]:5432/dbname"
 SECRET_KEY = ""
 ALGORITHM = HS256
 ACCESS_TOKEN_EXPIRE_MINUTES = 10

.github/workflows/cd.dev.yml

@@ -0,0 +1,36 @@
+name: Dev Branch Deployment
+
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types:
+      - completed
+    branches: [dev]
+
+jobs:
+  on-success:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Use SSH Action
+        uses: appleboy/[email protected]
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          password: ${{ secrets.PASSWORD }}
+          script: |
+            cd python/dev_source_code/
+            git pull origin dev
+            source .venv/bin/activate
+            pip install -r requirements.txt
+
+
+
+  on-failure:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+    steps:
+      - run: echo 'The triggering workflow failed'

.github/workflows/cd.prod.yml

@@ -0,0 +1,36 @@
+name: Dev Branch Deployment
+
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types:
+      - completed
+    branches: [main]
+
+jobs:
+  on-success:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Use SSH Action
+        uses: appleboy/[email protected]
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          password: ${{ secrets.PASSWORD }}
+          script: |
+            cd python/prod_source_code/
+            git pull origin main
+            source .venv/bin/activate
+            pip install -r requirements.txt
+
+
+
+  on-failure:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+    steps:
+      - run: echo 'The triggering workflow failed'

.github/workflows/cd.staging.yml

@@ -0,0 +1,36 @@
+name: Dev Branch Deployment
+
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types:
+      - completed
+    branches: [staging]
+
+jobs:
+  on-success:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Use SSH Action
+        uses: appleboy/[email protected]
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          password: ${{ secrets.PASSWORD }}
+          script: |
+            cd python/staging_source_code/
+            git pull origin staging
+            source .venv/bin/activate
+            pip install -r requirements.txt
+
+
+
+  on-failure:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+    steps:
+      - run: echo 'The triggering workflow failed'

.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  push:
+    branches: [main, staging, dev]
+  pull_request:
+    branches: [main, staging, dev]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_USER: 
+          POSTGRES_PASSWORD: 
+          POSTGRES_DB: 
+        ports:
+          - 5432:5432
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+          virtual-environment: venv
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+
+      # - name: Copy env file
+      #   run: cp .env.sample .env
+
+      # - name: Copy env file for main
+      #   if: github.ref == 'refs/heads/main'
+      #   run: cp .env.production .env
+
+      # - name: Copy env file for staging
+      #   if: github.ref == 'refs/heads/staging'
+      #   run: cp .env.staging .env
+
+      # - name: Run migrations
+      #   run: |
+      #     activate
+      #     alembic upgrade head
+
+      # - name: Run tests
+      #   run: |
+      #     activate
+      #     pytest

README.md

@@ -20,3 +20,63 @@ FastAPI boilerplate
  python main.py
 ```
 
+## **DATABASE TEST SETUP**
+
+To set up the database, follow the following steps:
+
+**Cloning**
+- clone the repository using `git clone https://github.com/hngprojects/hng_boilerplate_python_fastapi_web`
+- `cd` into the directory hng_boilerplate_python_fastapi_web
+- switch branch using `git checkout Muritadhor`
+
+**Environment Setup**
+- run `pip install -r requrements.txt` to install dependencies
+- create a `.env` file in the root directory and copy the content of `.env.sample` and update it accordingly
+
+**Create your local database**
+```bash
+sudo -u root psql
+```
+```sql
+CREATE USER user WITH PASSWORD 'password';
+CREATE DATABASE hng_fast_api;
+GRANT ALL PRIVILEGES ON DATABASE hng_fast_api TO user;
+```
+
+**Migrate the database**
+```bash
+alembic revision --autogenerate -m "Initial migrate"
+alembic upgrade head
+```
+
+**create dummy data**
+```bash
+python3 db_test.py
+```
+This should run without any errors
+
+**Using the database in your route files:**
+
+make sure to add the following to your file
+
+```python
+from api.db.database import create_database, get_db
+from api.v1.models.user import User
+from api.v1.models.org import Organization
+from api.v1.models.profile import Profile
+from api.v1.models.product import Product
+
+create_database()
+db = next(get_db())
+```
+Then use the db for your queries
+
+example
+```python
+db.add(User(email="test@mail", username="testuser", password="testpass", first_name="John", last_name="Doe"))
+```
+
+
+**Adding tables and columns to models**
+
+After creating new tables, or adding new models. Make sure to run alembic revision --autogenerate -m "Migration messge"

alembic.ini

@@ -0,0 +1,116 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = 
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S