rebuilt app from app2 developments

Author: joeygrable94

.flake8

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ "prod" ]
+    branches: [ "main" ]
   pull_request:
-    branches: [ "prod" ]
+    branches: [ "main" ]
   workflow_dispatch:
 
 jobs:
@@ -18,68 +18,69 @@ jobs:
       fail-fast: true
       matrix:
         os: ["ubuntu-latest"]
-        python-version: ["3.11"]
+        python-version: ["3.12"]
     env:
       API_MODE: "test"
       ENVIRONMENT: "pytest"
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+      # core
       API_ALLOWED_CORS: ${{ secrets.API_ALLOWED_CORS }}
       API_RSA_PRIVATE_KEY: ${{ secrets.API_RSA_PRIVATE_KEY }}
       API_RSA_PUBLIC_KEY: ${{ secrets.API_RSA_PUBLIC_KEY }}
       API_SECRET_KEY: ${{ secrets.API_SECRET_KEY }}
       API_CSRF_KEY: ${{ secrets.API_CSRF_KEY }}
       API_ENCRYPTION_KEY: ${{ secrets.API_ENCRYPTION_KEY }}
       API_ENCRYPTION_SALT: ${{ secrets.API_ENCRYPTION_SALT }}
+      # limits
       API_QUERY_LIMIT_OFFSET_DEFAULT: ${{ secrets.API_QUERY_LIMIT_OFFSET_DEFAULT }}
       API_QUERY_LIMIT_ROWS_DEFAULT: ${{ secrets.API_QUERY_LIMIT_ROWS_DEFAULT }}
       API_QUERY_LIMIT_ROWS_MAX: ${{ secrets.API_QUERY_LIMIT_ROWS_MAX }}
-      AUTH0_DOMAIN: ${{ secrets.AUTH0_DOMAIN }}
-      AUTH0_API_AUDIENCE: ${{ secrets.AUTH0_API_AUDIENCE }}
-      AUTH0_SPA_CLIENT_ID: ${{ secrets.AUTH0_SPA_CLIENT_ID }}
-      AUTH0_SPA_CLIENT_SECRET: ${{ secrets.AUTH0_SPA_CLIENT_SECRET }}
-      AUTH0_M2M_CLIENT_ID: ${{ secrets.AUTH0_M2M_CLIENT_ID }}
-      AUTH0_M2M_CLIENT_SECRET: ${{ secrets.AUTH0_M2M_CLIENT_SECRET }}
-      AUTH0_FIRST_ADMIN_AUTH_ID: ${{ secrets.AUTH0_FIRST_ADMIN_AUTH_ID }}
-      AUTH0_FIRST_ADMIN: ${{ secrets.AUTH0_FIRST_ADMIN }}
-      AUTH0_FIRST_ADMIN_PASSWORD: ${{ secrets.AUTH0_FIRST_ADMIN_PASSWORD }}
-      AUTH0_FIRST_ADMIN_PICTURE: ${{ secrets.AUTH0_FIRST_ADMIN_PICTURE }}
-      AUTH0_FIRST_MANAGER_AUTH_ID: ${{ secrets.AUTH0_FIRST_MANAGER_AUTH_ID }}
-      AUTH0_FIRST_MANAGER: ${{ secrets.AUTH0_FIRST_MANAGER }}
-      AUTH0_FIRST_MANAGER_PASSWORD: ${{ secrets.AUTH0_FIRST_MANAGER_PASSWORD }}
-      AUTH0_FIRST_MANAGER_PICTURE: ${{ secrets.AUTH0_FIRST_MANAGER_PICTURE }}
-      AUTH0_FIRST_EMPLOYEE_AUTH_ID: ${{ secrets.AUTH0_FIRST_EMPLOYEE_AUTH_ID }}
-      AUTH0_FIRST_EMPLOYEE: ${{ secrets.AUTH0_FIRST_EMPLOYEE }}
-      AUTH0_FIRST_EMPLOYEE_PASSWORD: ${{ secrets.AUTH0_FIRST_EMPLOYEE_PASSWORD }}
-      AUTH0_FIRST_EMPLOYEE_PICTURE: ${{ secrets.AUTH0_FIRST_EMPLOYEE_PICTURE }}
-      AUTH0_FIRST_CLIENT_A_AUTH_ID: ${{ secrets.AUTH0_FIRST_CLIENT_A_AUTH_ID }}
-      AUTH0_FIRST_CLIENT_A: ${{ secrets.AUTH0_FIRST_CLIENT_A }}
-      AUTH0_FIRST_CLIENT_A_PASSWORD: ${{ secrets.AUTH0_FIRST_CLIENT_A_PASSWORD }}
-      AUTH0_FIRST_CLIENT_A_PICTURE: ${{ secrets.AUTH0_FIRST_CLIENT_A_PICTURE }}
-      AUTH0_FIRST_CLIENT_B_AUTH_ID: ${{ secrets.AUTH0_FIRST_CLIENT_B_AUTH_ID }}
-      AUTH0_FIRST_CLIENT_B: ${{ secrets.AUTH0_FIRST_CLIENT_B }}
-      AUTH0_FIRST_CLIENT_B_PASSWORD: ${{ secrets.AUTH0_FIRST_CLIENT_B_PASSWORD }}
-      AUTH0_FIRST_CLIENT_B_PICTURE: ${{ secrets.AUTH0_FIRST_CLIENT_B_PICTURE }}
-      AUTH0_FIRST_USER_VERIFIED_AUTH_ID: ${{ secrets.AUTH0_FIRST_USER_VERIFIED_AUTH_ID }}
-      AUTH0_FIRST_USER_VERIFIED: ${{ secrets.AUTH0_FIRST_USER_VERIFIED }}
-      AUTH0_FIRST_USER_VERIFIED_PASSWORD: ${{ secrets.AUTH0_FIRST_USER_VERIFIED_PASSWORD }}
-      AUTH0_FIRST_USER_UNVERIFIED_AUTH_ID: ${{ secrets.AUTH0_FIRST_USER_UNVERIFIED_AUTH_ID }}
-      AUTH0_FIRST_USER_UNVERIFIED: ${{ secrets.AUTH0_FIRST_USER_UNVERIFIED }}
-      AUTH0_FIRST_USER_UNVERIFIED_PASSWORD: ${{ secrets.AUTH0_FIRST_USER_UNVERIFIED_PASSWORD }}
+      # auth
+      AUTH_RULE_NAMESPACE: ${{ secrets.AUTH_RULE_NAMESPACE }}
+      AUTH_DOMAIN: ${{ secrets.AUTH_DOMAIN }}
+      AUTH_API_AUDIENCE: ${{ secrets.AUTH_API_AUDIENCE }}
+      AUTH_SPA_CLIENT_ID: ${{ secrets.AUTH_SPA_CLIENT_ID }}
+      AUTH_SPA_CLIENT_SECRET: ${{ secrets.AUTH_SPA_CLIENT_SECRET }}
+      AUTH_M2M_CLIENT_ID: ${{ secrets.AUTH_M2M_CLIENT_ID }}
+      AUTH_M2M_CLIENT_SECRET: ${{ secrets.AUTH_M2M_CLIENT_SECRET }}
+      # users
+      AUTH_FIRST_ADMIN_AUTH_ID: ${{ secrets.AUTH_FIRST_ADMIN_AUTH_ID }}
+      AUTH_FIRST_ADMIN: ${{ secrets.AUTH_FIRST_ADMIN }}
+      AUTH_FIRST_ADMIN_PASSWORD: ${{ secrets.AUTH_FIRST_ADMIN_PASSWORD }}
+      AUTH_FIRST_MANAGER_AUTH_ID: ${{ secrets.AUTH_FIRST_MANAGER_AUTH_ID }}
+      AUTH_FIRST_MANAGER: ${{ secrets.AUTH_FIRST_MANAGER }}
+      AUTH_FIRST_MANAGER_PASSWORD: ${{ secrets.AUTH_FIRST_MANAGER_PASSWORD }}
+      AUTH_FIRST_EMPLOYEE_AUTH_ID: ${{ secrets.AUTH_FIRST_EMPLOYEE_AUTH_ID }}
+      AUTH_FIRST_EMPLOYEE: ${{ secrets.AUTH_FIRST_EMPLOYEE }}
+      AUTH_FIRST_EMPLOYEE_PASSWORD: ${{ secrets.AUTH_FIRST_EMPLOYEE_PASSWORD }}
+      AUTH_FIRST_CLIENT_A_AUTH_ID: ${{ secrets.AUTH_FIRST_CLIENT_A_AUTH_ID }}
+      AUTH_FIRST_CLIENT_A: ${{ secrets.AUTH_FIRST_CLIENT_A }}
+      AUTH_FIRST_CLIENT_A_PASSWORD: ${{ secrets.AUTH_FIRST_CLIENT_A_PASSWORD }}
+      AUTH_FIRST_CLIENT_B_AUTH_ID: ${{ secrets.AUTH_FIRST_CLIENT_B_AUTH_ID }}
+      AUTH_FIRST_CLIENT_B: ${{ secrets.AUTH_FIRST_CLIENT_B }}
+      AUTH_FIRST_CLIENT_B_PASSWORD: ${{ secrets.AUTH_FIRST_CLIENT_B_PASSWORD }}
+      AUTH_FIRST_USER_VERIFIED_AUTH_ID: ${{ secrets.AUTH_FIRST_USER_VERIFIED_AUTH_ID }}
+      AUTH_FIRST_USER_VERIFIED: ${{ secrets.AUTH_FIRST_USER_VERIFIED }}
+      AUTH_FIRST_USER_VERIFIED_PASSWORD: ${{ secrets.AUTH_FIRST_USER_VERIFIED_PASSWORD }}
+      AUTH_FIRST_USER_UNVERIFIED_AUTH_ID: ${{ secrets.AUTH_FIRST_USER_UNVERIFIED_AUTH_ID }}
+      AUTH_FIRST_USER_UNVERIFIED: ${{ secrets.AUTH_FIRST_USER_UNVERIFIED }}
+      AUTH_FIRST_USER_UNVERIFIED_PASSWORD: ${{ secrets.AUTH_FIRST_USER_UNVERIFIED_PASSWORD }}
+      # email
       EMAIL_ENABLED: ${{ secrets.EMAIL_ENABLED }}
       EMAIL_FROM_EMAIL: ${{ secrets.EMAIL_FROM_EMAIL }}
       EMAIL_FROM_NAME: ${{ secrets.EMAIL_FROM_NAME }}
       EMAIL_PROVIDER_RESTRICTION: ${{ secrets.EMAIL_PROVIDER_RESTRICTION }}
       EMAIL_ALLOWED_PROVIDERS: ${{ secrets.EMAIL_ALLOWED_PROVIDERS }}
       EMAIL_ALLOWED_FROM_EMAILS: ${{ secrets.EMAIL_ALLOWED_FROM_EMAILS }}
       EMAIL_TEST_USER: ${{ secrets.EMAIL_TEST_USER }}
+      # cloudkeys
       CLOUDKEY_IPINFO: ${{ secrets.CLOUDKEY_IPINFO }}
       CLOUDKEY_GOOGLE_API: ${{ secrets.CLOUDKEY_GOOGLE_API }}
       CLOUDKEY_AWS_ACCESS_KEY_ID: ${{ secrets.CLOUDKEY_AWS_ACCESS_KEY_ID }}
       CLOUDKEY_AWS_SECRET_ACCESS_KEY: ${{ secrets.CLOUDKEY_AWS_SECRET_ACCESS_KEY }}
       CLOUDKEY_AWS_DEFAULT_REGION: ${{ secrets.CLOUDKEY_AWS_DEFAULT_REGION }}
       CLOUDKEY_AWS_S3_DEFAULT_BUCKET: ${{ secrets.CLOUDKEY_AWS_S3_DEFAULT_BUCKET }}
-      AWS_GITHUB_OIDC_ROLE_ARN: ${{ secrets.AWS_GITHUB_OIDC_ROLE_ARN }}
       AWS_ACCESS_KEY_ID: ${{ secrets.CLOUDKEY_AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.CLOUDKEY_AWS_SECRET_ACCESS_KEY }}
       AWS_DEFAULT_REGION: ${{ secrets.CLOUDKEY_AWS_S3_DEFAULT_BUCKET }}
@@ -101,9 +102,7 @@ jobs:
       - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip \
-          && python -m pip install poetry \
-          && poetry config virtualenvs.create false \
-          && poetry install --no-root
+          && python -m pip install -r requirements.txt
       - name: Run Python Tests
         run: |
           bash ./scripts/test-cov.sh

.github/workflows/ci.yml

@@ -7,14 +7,14 @@ repos:
     hooks:
       - id: format-code
         name: format-code
-        entry: ./scripts/format.sh
+        entry: ./scripts/ruff-check.sh
         language: script
         pass_filenames: false
   - repo: local
     hooks:
       - id: lint-code
         name: lint-code
-        entry: ./scripts/lint.sh
+        entry: ./scripts/ruff-fix.sh
         language: script
         pass_filenames: false
 #   - repo: local

.pre-commit-config.yaml

@@ -0,0 +1 @@
+3.12.7

.python-version

@@ -3,6 +3,7 @@
 [![CodeQL](https://github.com/joeygrable94/GCAPI-Backend/actions/workflows/codeql.yml/badge.svg)](https://github.com/joeygrable94/GCAPI-Backend/actions/workflows/codeql.yml) [![GitHub CI](https://github.com/joeygrable94/GCAPI-Backend/actions/workflows/ci.yml/badge.svg)](https://github.com/joeygrable94/GCAPI-Backend/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/joeygrable94/GCAPI-Backend/branch/main/graph/badge.svg?token=8FCB50574D)](https://codecov.io/gh/joeygrable94/GCAPI-Backend)
 
 - [GCAPI Backend](#gcapi-backend)
+  - [Pytest](#pytest)
   - [Getting Started](#getting-started)
   - [Application Structure](#application-structure)
   - [Security Resources](#security-resources)
@@ -14,13 +15,31 @@
     - [Commands](#commands)
   - [SQLAlchemy ORM](#sqlalchemy-orm)
     - [Pagination](#pagination)
-  - [PyTest](#pytest)
+  - [PyTest](#pytest-1)
     - [PyTest Commands](#pytest-commands)
     - [PyTest Resources](#pytest-resources)
   - [External Resources](#external-resources)
+  - [Useful Commands](#useful-commands)
 
 ---
 
+## Pytest
+
+```bash
+crud
+
+core/pagination/core
+core/security/auth/exceptions
+core/security/csrf/core
+core/security/csrf/csrf_config
+core/security/csrf/exceptions
+core/security/permissions/exceptions
+
+api/deps
+api/exceptions
+api/v1/endpoints
+```
+
 ## Getting Started
 
 First check to ensure Python 3.11 is installed and is the current version in use.
@@ -185,3 +204,19 @@ pytest tests/api/api_v1/test_websites.py
 ## External Resources
 
 - [IPInfo.io](https://ipinfo.io/)
+
+---
+
+## Useful Commands
+
+Delete DS_Store files
+
+```bash
+find . -name '.DS_Store' -type f -delete
+```
+
+Delete all python cache files
+
+```bash
+find . | grep -E "(/__pycache__$|\.pyc$|\.pyo$)" | xargs rm -rf
+```

README.md

@@ -5,11 +5,11 @@
 import sys
 from logging.config import fileConfig
 
-from alembic import context
 from dotenv import load_dotenv
-from pydantic_core import Url
 from sqlalchemy import URL, engine_from_config, pool
 
+from alembic import context
+
 load_dotenv()
 
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -40,10 +40,12 @@
 # my_important_option = config.get_main_option("my_important_option")
 # ... etc.
 
+
 # database uri
 def get_url() -> str | URL:
     return settings.db.uri
 
+
 def get_async_url() -> str | URL:
     return settings.db.uri_async
 
@@ -81,7 +83,9 @@ def run_migrations_online():
     assert configuration
     configuration["sqlalchemy.url"] = str(url)
     connectable = engine_from_config(
-        configuration, prefix="sqlalchemy.", poolclass=pool.NullPool,
+        configuration,
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
     )
 
     with connectable.connect() as connection:

alembic/env.py

@@ -5,32 +5,38 @@
 Create Date: 2024-10-29 22:36:24.996539
 
 """
+
 import sqlalchemy as sa
-from alembic import op
-from sqlalchemy.dialects import mysql
 
+from alembic import op
 from app.db.custom_types.longtext import LongText
 
 # revision identifiers, used by Alembic.
-revision = '06ebefa81a2b'
-down_revision = 'b7f0de526452'
+revision = "06ebefa81a2b"
+down_revision = "b7f0de526452"
 branch_labels = None
 depends_on = None
 
 
 def upgrade() -> None:
     # ### commands auto generated by Alembic - please adjust! ###
-    op.alter_column('gcft_snap_hotspotclick', 'hotspot_content',
-               existing_type=sa.BLOB(),
-               type_=LongText(),
-               existing_nullable=True)
+    op.alter_column(
+        "gcft_snap_hotspotclick",
+        "hotspot_content",
+        existing_type=sa.BLOB(),
+        type_=LongText(),
+        existing_nullable=True,
+    )
     # ### end Alembic commands ###
 
 
 def downgrade() -> None:
     # ### commands auto generated by Alembic - please adjust! ###
-    op.alter_column('gcft_snap_hotspotclick', 'hotspot_content',
-               existing_type=LongText(),
-               type_=sa.BLOB(),
-               existing_nullable=True)
+    op.alter_column(
+        "gcft_snap_hotspotclick",
+        "hotspot_content",
+        existing_type=LongText(),
+        type_=sa.BLOB(),
+        existing_nullable=True,
+    )
     # ### end Alembic commands ###

alembic/versions/06ebefa81a2b_updated_hotspot_content.py

@@ -5,25 +5,26 @@
 Create Date: 2024-09-18 13:00:17.957395
 
 """
+
 import sqlalchemy as sa
-from alembic import op
-from sqlalchemy.dialects import mysql
 from sqlalchemy_utils.types.json import JSONType
 
+from alembic import op
+
 # revision identifiers, used by Alembic.
-revision = '1bc48e91aa39'
-down_revision = '7a61307f0405'
+revision = "1bc48e91aa39"
+down_revision = "7a61307f0405"
 branch_labels = None
 depends_on = None
 
 
 def upgrade() -> None:
     # ### commands auto generated by Alembic - please adjust! ###
-    op.add_column('client', sa.Column('style_guide', JSONType(), nullable=True))
+    op.add_column("client", sa.Column("style_guide", JSONType(), nullable=True))
     # ### end Alembic commands ###
 
 
 def downgrade() -> None:
     # ### commands auto generated by Alembic - please adjust! ###
-    op.drop_column('client', 'style_guide')
+    op.drop_column("client", "style_guide")
     # ### end Alembic commands ###