Update ci.yml

.github/workflows/ci.yml

@@ -0,0 +1,89 @@
+name: Lint, Test, Tag & Publish
+
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - "**/.github/**"
+      - "**/.gitignore"
+      - "**/.vscode/**"
+      - "**/README.md"
+      - "**/CHANGELOG.md"
+  workflow_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: psf/black@stable
+      with:
+        options: "-l 100 --exclude '/.venv/|/__init__.py'"
+    - uses: creyD/autoflake_action@master
+      with:
+        no_commit: True
+        options: --in-place --remove-all-unused-imports -r --exclude **/__init__.py,**/db/models.py,
+    - uses: stefanzweifel/git-auto-commit-action@v5
+      with:
+        commit_message: Adjusted files for isort & autopep
+
+  test:
+    runs-on: ubuntu-latest
+    needs: lint
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: python -m pip install --upgrade pip
+      - run: python -m pip install -r requirements.txt
+      - run: python test.py
+
+  tag_and_publish:
+    runs-on: ubuntu-latest
+    needs: test
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-tags: true
+
+      - name: setup git
+        run: |
+          git config --local user.email "actions@github.com"
+          git config --local user.name "GitHub Action"
+
+      - name: Git Version
+        uses: codacy/git-version@2.8.0
+        id: git_version
+        with:
+          minor-identifier: "feat:"
+          major-identifier: "breaking:"
+
+      - name: Create Tag
+        run: git tag ${{ steps.git_version.outputs.version }}
+
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: Add new tag
+          push_options: --tags
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.build.txt
+          python setup.py sdist bdist_wheel
+
+      - name: Build and publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/lint.yml

@@ -1,29 +0,0 @@
-name: Lint
-
-on:
-  push:
-    branches:
-      - dev
-      - master
-    paths-ignore:
-      - "**/.github/**"
-      - "**/.gitignore"
-      - "**/.vscode/**"
-      - "**/README.md"
-      - "**/CHANGELOG.md"
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - uses: psf/black@stable
-      with:
-        options: "-l 100 --exclude '/.venv/|/__init__.py'"
-    - uses: creyD/autoflake_action@master
-      with:
-        no_commit: True
-        options: --in-place --remove-all-unused-imports -r --exclude **/__init__.py,**/db/models.py,
-    - uses: stefanzweifel/git-auto-commit-action@v5
-      with:
-        commit_message: Adjusted files for isort & autopep

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Conrad
+Copyright (c) 2024 Conrad Großer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

creyPY/const/__init__.py

@@ -1,2 +1,3 @@
+from .groups import *  # noqa
 from .i18n import *  # noqa
 from .stripe import *  # noqa

creyPY/const/groups.py

@@ -0,0 +1,10 @@
+import enum
+
+
+class GroupMode(str, enum.Enum):
+    Minute = "1m"
+    Hour = "1h"
+    Day = "1d"
+    Week = "7d"
+    Month = "1mo"
+    Year = "1y"

creyPY/fastapi/__init__.py

@@ -0,0 +1,5 @@
+from .app import *  # noqa
+from .crud import *  # noqa
+from .models import *  # noqa
+from .pagination import *  # noqa
+from .schemas import *  # noqa

creyPY/fastapi/app.py

@@ -0,0 +1,23 @@
+import re
+
+from fastapi.routing import APIRoute
+
+
+# Swagger operation ID config
+def generate_unique_id(route: APIRoute) -> str:
+    op_id = re.sub(r"{.*?}", "", route.path_format)  # remove path parameters
+    operation_id = re.sub(r"\W", "_", op_id.replace("//", "/"))[
+        1:
+    ]  # replace non-alphanumeric characters with underscores
+    assert route.methods
+    # if the route doesn't end with an underscore we should add one
+    if operation_id[-1] != "_":
+        operation_id += "_"
+    # If get method and no {} in the path, it should be called list
+    if "GET" in route.methods and "{" not in route.path_format:
+        operation_id = operation_id + "list"
+    else:
+        operation_id = (
+            operation_id + list(route.methods)[0].lower()
+        )  # add first (and only) method to operation_id
+    return operation_id

creyPY/fastapi/crud.py

@@ -0,0 +1,61 @@
+from typing import Type, TypeVar
+from uuid import UUID
+
+from fastapi import HTTPException
+from pydantic import BaseModel
+from sqlalchemy.orm import Session
+
+from .models.base import Base
+
+T = TypeVar("T", bound=Base)
+
+
+def get_object_or_404(db_class: Type[T], id: UUID | str, db: Session, expunge: bool = False) -> T:
+    obj = db.query(db_class).filter(db_class.id == id).one_or_none()
+    if obj is None:
+        raise HTTPException(status_code=404, detail="The object does not exist.")
+    if expunge:
+        db.expunge(obj)
+    return obj
+
+
+# TODO: Add testing
+def create_obj_from_data(
+    data: BaseModel, model: Type[T], db: Session, additonal_data={}, exclude={}
+) -> T:
+    obj = model(**data.model_dump(exclude=exclude) | additonal_data)
+    db.add(obj)
+    db.commit()
+    db.refresh(obj)
+    return obj
+
+
+# TODO: Add testing
+def update_obj_from_data(
+    data: BaseModel,
+    model: Type[T],
+    id: UUID | str,
+    db: Session,
+    partial: bool = False,
+    ignore_fields=[],
+    additional_data={},
+    exclude={},
+) -> T:
+    obj = get_object_or_404(model, id, db)
+    data_dict = data.model_dump(exclude_unset=not partial, exclude=exclude)
+    data_dict.update(additional_data)  # merge additional_data into data_dict
+    for field in data_dict:
+        if field not in ignore_fields:
+            setattr(obj, field, data_dict[field])
+    db.commit()
+    db.refresh(obj)
+    return obj
+
+
+# TODO: Add testing
+def delete_object(db_class: Type[T], id: UUID | str, db: Session) -> None:
+    obj = db.query(db_class).filter(db_class.id == id).one_or_none()
+    if obj is None:
+        raise HTTPException(status_code=404, detail="The object does not exist.")
+    db.delete(obj)
+    db.commit()

creyPY/fastapi/models/__init__.py

@@ -0,0 +1 @@
+from .base import *  # noqa

creyPY/fastapi/models/base.py

@@ -0,0 +1,28 @@
+import uuid
+from datetime import datetime
+
+from sqlalchemy import Column, DateTime, String
+from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.ext.declarative import declared_attr
+from sqlalchemy.orm import as_declarative
+from sqlalchemy.sql import func
+
+
+@as_declarative()
+class Base:
+    __abstract__ = True
+    # Primary key as uuid
+    id = Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
+    created_at = Column(DateTime(timezone=True), server_default=func.now())
+    updated_at = Column(DateTime, default=datetime.utcnow, onupdate=datetime.utcnow)
+    created_by_id = Column(String)
+
+    __name__: str
+
+    # TODO: Add default representation string
+    # TODO: Add automated foreign key resolution
+
+    # Generate __tablename__ automatically
+    @declared_attr
+    def __tablename__(cls) -> str:
+        return cls.__name__.lower()

creyPY/fastapi/pagination.py

@@ -0,0 +1,72 @@
+from math import ceil
+from typing import Any, Generic, Optional, Self, Sequence, TypeVar
+
+from fastapi_pagination import Params
+from fastapi_pagination.bases import AbstractPage, AbstractParams
+from fastapi_pagination.types import GreaterEqualOne, GreaterEqualZero
+from pydantic.json_schema import SkipJsonSchema
+
+T = TypeVar("T")
+
+
+# TODO: Add complete fastapi-pagination proxy here
+# TODO: Add pagination off functionality
+# SkipJsonSchema is used to avoid generating invalid JSON schema in FastAPI
+class Page(AbstractPage[T], Generic[T]):
+    results: Sequence[T]
+    page: GreaterEqualOne | SkipJsonSchema[None] = None
+    size: GreaterEqualOne | SkipJsonSchema[None] = None
+    pages: GreaterEqualZero | SkipJsonSchema[None] = None
+    total: GreaterEqualZero
+    has_next: bool | SkipJsonSchema[None] = None
+    has_prev: bool | SkipJsonSchema[None] = None
+
+    __params_type__ = Params
+
+    @classmethod
+    def create(
+        cls,
+        items: Sequence[T],
+        params: AbstractParams,
+        *,
+        total: Optional[int] = None,
+        **kwargs: Any,
+    ) -> Self:
+        if not isinstance(params, Params):
+            raise TypeError("Page should be used with Params")
+
+        size = params.size or total or len(items)
+        page = params.page or 1
+        pages = None
+
+        if total is not None:
+            if total == 0:
+                pages = 1
+            else:
+                pages = ceil(total / size)
+
+        has_next = page < (pages or 1)
+        has_prev = page > 1
+
+        return cls(
+            total=total,
+            results=items,
+            page=page,
+            size=size,
+            pages=pages,
+            has_next=has_next,
+            has_prev=has_prev,
+        )
+
+
+# Parse response from an SDK to a PAGE
+def parse_page(response, page: int, size: int) -> Page:
+    return Page(
+        page=page,
+        size=size,
+        total=response.total,
+        results=response.results,
+        pages=response.pages or 1,
+        has_next=response.has_next,
+        has_prev=response.has_prev,
+    )

creyPY/fastapi/schemas/__init__.py

@@ -0,0 +1 @@
+from .base import *  # noqa

creyPY/fastapi/schemas/base.py

@@ -0,0 +1,16 @@
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict
+
+
+# The created_by_id is a string because we use the sub from Auth0
+class BaseSchemaModelIN(BaseModel):
+    created_by_id: str
+    model_config = ConfigDict(from_attributes=True)
+
+
+class BaseSchemaModelOUT(BaseSchemaModelIN):
+    id: UUID
+    created_at: datetime
+    updated_at: datetime

requirements.build.txt

@@ -23,3 +23,5 @@ twine==5.0.0
 urllib3==2.2.1
 wheel==0.43.0
 zipp==3.18.1
+
+-r requirements.txt

requirements.txt

@@ -0,0 +1,12 @@
+annotated-types==0.6.0 # Pydantic
+pydantic==2.6.4 # Pydantic
+pydantic-core==2.16.3 # Pydantic
+typing-extensions==4.10.0 # Pydantic
+
+anyio==4.3.0 # Pagination
+fastapi==0.110.0 # Pagination
+fastapi-pagination==0.12.21 # Pagination
+sniffio==1.3.1 # Pagination
+starlette==0.36.3 # Pagination
+
+sqlalchemy==2.0.29 # SQLAlchemy

setup.py

@@ -1,13 +1,34 @@
+import subprocess
+
 from setuptools import find_packages, setup
 
+with open("requirements.txt") as f:
+    requirements = f.read().splitlines()
+
+
+def get_latest_git_tag() -> str:
+    try:
+        tag = (
+            subprocess.check_output(["git", "describe", "--tags", "--abbrev=0"])
+            .strip()
+            .decode("utf-8")
+        )
+        if tag.startswith("v"):
+            tag = tag[1:]
+    except subprocess.CalledProcessError:
+        raise RuntimeError("Unable to get latest git tag")
+    return str(tag)
+
+
 setup(
     name="creyPY",
-    version="0.0.5",
-    description="My collection of Python and FastAPI shortcuts etc.",
+    version=get_latest_git_tag(),
+    description="Collection of my Python and FastAPI shortcuts, snippets etc.",
     author="Conrad Großer",
     author_email="conrad@noah.tech",
     packages=find_packages(),
     url="https://github.com/creyD/creyPY",
     license="MIT",
     python_requires=">=3.12",
+    install_requires=requirements,
 )

test.py

@@ -0,0 +1,90 @@
+import unittest
+from uuid import UUID
+
+from fastapi import HTTPException
+from fastapi.routing import APIRoute
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+
+from creyPY.fastapi.app import generate_unique_id
+from creyPY.fastapi.crud import (
+    get_object_or_404,
+)
+from creyPY.fastapi.models.base import Base
+
+
+class MockDBClass(Base):
+    def __init__(self, id):
+        self.id = id
+
+
+class TestMyFunction(unittest.TestCase):
+    def setUp(self):
+        # Create a SQLite in-memory database for testing
+        engine = create_engine("sqlite:///:memory:")
+
+        # Create a sessionmaker bound to this engine
+        Session = sessionmaker(bind=engine)
+
+        # Now you can use Session() to get a session bound to the engine
+        self.db = Session()
+
+        # create the table
+        Base.metadata.create_all(engine)
+
+    def test_generate_unique_id(self):
+        # Test case 1: Route with no path parameters and GET method
+        route1 = APIRoute(path="/users", methods={"GET"}, endpoint=lambda: None)
+        assert generate_unique_id(route1) == "users_list"
+
+        # Test case 2: Route with path parameters and POST method
+        route2 = APIRoute(path="/users/{user_id}", methods={"POST"}, endpoint=lambda: None)
+        assert generate_unique_id(route2) == "users_post"
+
+        # Test case 3: Route with path parameters and multiple methods
+        route3 = APIRoute(path="/users/{user_id}", methods={"GET", "PUT"}, endpoint=lambda: None)
+        result = generate_unique_id(route3)
+        assert result == "users_get" or result == "users_put"
+
+        # Test case 4: Route with special characters in path
+        route4 = APIRoute(
+            path="/users/{user_id}/posts/{post_id}", methods={"DELETE"}, endpoint=lambda: None
+        )
+        assert generate_unique_id(route4) == "users_posts_delete"
+
+        # Test case 5: Route with multiple path parameters and PATCH method
+        route5 = APIRoute(
+            path="/users/{user_id}/posts/{post_id}", methods={"PATCH"}, endpoint=lambda: None
+        )
+        assert generate_unique_id(route5) == "users_posts_patch"
+
+        # Test case 6: Route with no path parameters and PUT method
+        route6 = APIRoute(path="/users", methods={"PUT"}, endpoint=lambda: None)
+        assert generate_unique_id(route6) == "users_put"
+
+    def test_get_object_or_404_existing_object(self):
+        # Arrange
+        obj_id = UUID("123e4567-e89b-12d3-a456-426614174000")
+        obj = MockDBClass(obj_id)
+        self.db.add(obj)
+        self.db.commit()
+
+        # Act
+        result = get_object_or_404(MockDBClass, obj_id, self.db)
+
+        # Assert
+        assert result == obj
+
+    def test_get_object_or_404_non_existing_object(self):
+        # Arrange
+        obj_id = UUID("123e4567-e89b-12d3-a456-426614174000")
+
+        # Act & Assert
+        with self.assertRaises(HTTPException) as exc_info:
+            get_object_or_404(MockDBClass, obj_id, self.db)
+        assert exc_info.exception.status_code == 404
+        assert exc_info.exception.detail == "The object does not exist."
+
+
+if __name__ == "__main__":
+    unittest.main()