breaking: Release of 1.0.0

.github/workflows/ci.yml

@@ -0,0 +1,90 @@
+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
+      contents: write # for the tags
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-tags: true
+          ref: ${{ github.ref }}
+          fetch-depth: 0
+
+      - name: setup git
+        run: |
+          git config --local user.email "15138480+creyD@users.noreply.github.com"
+          git config --local user.name "creyD"
+
+      - 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 }}
+
+      - name: Push tag
+        run: git push origin ${{ steps.git_version.outputs.version }}
+
+      - 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,46 +0,0 @@
-name: Lint and tag
-
-on:
-  push:
-    branches:
-      - 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
-
-  tag:
-    runs-on: ubuntu-latest
-    needs: lint
-    steps:        
-      - name: Git Version
-        uses: codacy/git-version@2.8.0
-        id: git_version
-        with:
-          prefix: v
-          minor-identifier: "feat:"
-          major-identifier: "breaking:"
-
-      - name: Create Tag
-        run: git tag -a v${{ steps.git_version.outputs.version }} -m "v${{ steps.git_version.outputs.version }}"
-
-      - name: Push Tag
-        run: git push origin v${{ steps.git_version.outputs.version }}

.github/workflows/publish.yml

@@ -1,29 +0,0 @@
-name: Publish to pypi
-
-on:
-  push:
-    tags:
-      - '*'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - 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
-
-    - name: Build and publish
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 1.0.0
+
+- Bumped dependencies
+- Added const documentation
+- Added installation instructions and examples to README
+- Added sqlalchemy session for db connection
+
+## 0.2.0
+
+- Added testing client

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

README.md

@@ -1,9 +1,62 @@
 # creyPY
+
 My collection of Python and FastAPI shortcuts etc.
 
+## Installation
 
-# Release
+```bash
+pip install creyPY -U
+```
 
-``` rm -rf dist build creyPY.egg-info && python setup.py sdist bdist_wheel ```
+## Versioning
 
-``` twine upload dist/* ```
+This library uses [Semantic Versioning](https://semver.org/).
+
+## FastAPI
+
+This library installes fastapi and pydantic, as well as sqlalchemy for you. It also provides a sqlalchemy base class and companion pydantic schemas. Also there are some helper functions for FastAPI in `creyPY.fastapi.app` like `generate_unique_id` to generate unique operation IDs for the OpenAPI schema to work with code generators.
+
+### Database connection
+
+The `creyPY.fastapi.db` module provides a `Session` class that can be used as a context manager to connect to a database. It exposes the `SQLALCHEMY_DATABASE_URL` variable for you to use. It uses the following environment variables:
+
+- `POSTGRES_HOST`: The host of the database
+- `POSTGRES_PORT`: The port of the database
+- `POSTGRES_USER`: The user of the database
+- `POSTGRES_PASSWORD`: The password of the database
+- `POSTGRES_DB`: The database name
+
+Currently only PostgreSQL is supported. It creates a sync session, it is planned to add async support in the future. You can use this like this:
+
+```python
+from creyPY.fastapi.db.session import get_db
+
+async def test_endpoint(
+    db: Session = Depends(get_db),
+) -> Any:
+    pass
+```
+
+## Constants
+
+The constants module contains a few enums that I use in my projects. The best way to understand this library is to look at the code (it's not that much). However for simplicity, here is a brief overview:
+
+- LanguageEnum: Contains all languages according to ISO 639
+- CountryEnum: Contains all countries according to ISO 3166
+- CurrencyEnum: Contains all accepted stripe currencies (Commented out are the Zero-decimal currencies, to avoid custom implementation)
+- StripeStatus: Contains all stripe payment statuses
+- GroupMode: Contains time group modes (e.g. day, week, month, year)
+
+### Usage example
+
+```python
+from creyPY.const import LanguageEnum
+
+print(LanguageEnum.EN) # Output: LanguageEnum.EN
+print(LanguageEnum.EN.value) # Output: English
+``` 
+
+
+## TODO
+
+- Add async support for database connection

creyPY/const/i18n.py

@@ -1,6 +1,7 @@
 import enum
 
 
+# Source: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
 class CountryEnum(str, enum.Enum):
     AF = "Afghanistan"
     AX = "land Islands"
@@ -248,6 +249,7 @@ class CountryEnum(str, enum.Enum):
     ZW = "Zimbabwe"
 
 
+# :: https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
 class LanguageEnum(str, enum.Enum):
     AA = "Afar"
     AB = "Abkhazian"

creyPY/fastapi/__init__.py

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

creyPY/fastapi/crud.py

@@ -19,6 +19,7 @@ def get_object_or_404(db_class: Type[T], id: UUID | str, db: Session, expunge: b
     return obj
 
 
+# TODO: Add testing
 def create_obj_from_data(
     data: BaseModel, model: Type[T], db: Session, additonal_data={}, exclude={}
 ) -> T:
@@ -29,6 +30,7 @@ def create_obj_from_data(
     return obj
 
 
+# TODO: Add testing
 def update_obj_from_data(
     data: BaseModel,
     model: Type[T],
@@ -50,6 +52,7 @@ def update_obj_from_data(
     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:

creyPY/fastapi/db/__init__.py

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

creyPY/fastapi/db/session.py

@@ -0,0 +1,26 @@
+import os
+from typing import Generator
+
+from dotenv import load_dotenv
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+from sqlalchemy.orm.session import Session
+
+load_dotenv()
+
+host = os.getenv("POSTGRES_HOST", "localhost")
+user = os.getenv("POSTGRES_USER", "postgres")
+password = os.getenv("POSTGRES_PASSWORD", "root")
+port = os.getenv("POSTGRES_PORT", "5432")
+name = os.getenv("POSTGRES_DB", "fastapi")
+
+SQLALCHEMY_DATABASE_URL = f"postgresql+psycopg://{user}:{password}@{host}:{port}/"
+
+
+engine = create_engine(SQLALCHEMY_DATABASE_URL + name, pool_pre_ping=True)
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+
+def get_db() -> Generator[Session, None, None]:
+    with SessionLocal() as db:
+        yield db

creyPY/fastapi/models/base.py

@@ -19,6 +19,9 @@ class Base:
 
     __name__: str
 
+    # TODO: Add default representation string
+    # TODO: Add automated foreign key resolution
+
     # Generate __tablename__ automatically
     @declared_attr
     def __tablename__(cls) -> str:

creyPY/fastapi/pagination.py

@@ -9,6 +9,9 @@ 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

creyPY/fastapi/schemas/base.py

@@ -4,6 +4,7 @@ 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)

creyPY/fastapi/testing.py

@@ -0,0 +1,110 @@
+import json
+
+from fastapi.testclient import TestClient
+
+
+class GenericClient(TestClient):
+    def __init__(self, client):
+        self.c = TestClient(client)
+
+    def get(self, url: str, r_code: int = 200, parse_json=True):
+        re = self.c.get(url)
+        if re.status_code != r_code:
+            print(re.content)
+        assert r_code == re.status_code
+        return re.json() if parse_json else re.content
+
+    def delete(self, url: str, r_code: int = 204):
+        re = self.c.delete(url)
+        if re.status_code != r_code:
+            print(re.content)
+        assert r_code == re.status_code
+        return re.json() if r_code != 204 else None
+
+    def post(
+        self, url: str, obj: dict = {}, r_code: int = 201, raw_response=False, *args, **kwargs
+    ):
+        re = self.c.post(
+            url, data=json.dumps(obj), headers={"Content-Type": "application/json"}, *args, **kwargs
+        )
+        if re.status_code != r_code:
+            print(re.content)
+        assert r_code == re.status_code
+        return re.json() if not raw_response else re
+
+    def post_file(self, url: str, file, r_code: int = 201, raw_response=False, *args, **kwargs):
+        re = self.c.post(url, files={"file": file}, *args, **kwargs)
+        if re.status_code != r_code:
+            print(re.content)
+        assert r_code == re.status_code
+        return re.json() if not raw_response else re
+
+    def patch(
+        self, url: str, obj: dict = {}, r_code: int = 200, raw_response=False, *args, **kwargs
+    ):
+        re = self.c.patch(
+            url, data=json.dumps(obj), headers={"Content-Type": "application/json"}, *args, **kwargs
+        )
+        if re.status_code != r_code:
+            print(re.content)
+        assert r_code == re.status_code
+        return re.json() if not raw_response else re
+
+    def put(self, url: str, obj: dict = {}, r_code: int = 200, raw_response=False, *args, **kwargs):
+        re = self.c.put(
+            url,
+            data=json.dumps(obj),
+            headers={
+                "Content-Type": "application/json",
+                "accept": "application/json",
+            },
+            *args,
+            **kwargs,
+        )
+        if re.status_code != r_code:
+            print(re.content)
+        assert r_code == re.status_code
+        return re.json() if not raw_response else re
+
+    def obj_lifecycle(self, input_obj: dict, url: str, pagination: bool = True):
+        # GET LIST
+        re = self.get(url)
+        if pagination:
+            assert re["total"] == 0
+            assert len(re["results"]) == 0
+        else:
+            assert len(re) == 0
+
+        # CREATE
+        re = self.post(url, obj=input_obj)
+        assert "id" in re
+        assert re["id"] is not None
+        assert re["created_at"] is not None
+
+        obj_id = str(re["id"])
+
+        # GET
+        re = self.get(f"{url}{obj_id}/")
+        assert re["id"] == obj_id
+
+        # GET LIST
+        re = self.get(url)
+        if pagination:
+            assert re["total"] == 1
+            assert len(re["results"]) == 1
+        else:
+            assert len(re) == 1
+
+        # DELETE
+        self.delete(f"{url}{obj_id}")
+
+        # GET LIST
+        re = self.get(url)
+        if pagination:
+            assert re["total"] == 0
+            assert len(re["results"]) == 0
+        else:
+            assert len(re) == 0
+
+        # GET
+        self.get(f"{url}{obj_id}", parse_json=False, r_code=404)

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

@@ -3,10 +3,21 @@ 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
+anyio==4.3.0 # FastAPI
+fastapi==0.110.1 # FastAPI
+idna==3.6 # FastAPI
+sniffio==1.3.1 # FastAPI
+starlette==0.37.2 # FastAPI
 
+fastapi-pagination==0.12.21 # Pagination
 sqlalchemy==2.0.29 # SQLAlchemy
+
+python-dotenv==1.0.1 # Environment variables
+
+psycopg==3.1.18 # PostgreSQL
+psycopg-binary==3.1.18 # PostgreSQL
+psycopg-pool==3.2.1 # PostgreSQL
+
+h11==0.14.0 # Testing
+httpcore==1.0.5 # Testing
+httpx==0.27.0 # Testing

setup.py

@@ -23,7 +23,9 @@ def get_latest_git_tag() -> str:
 setup(
     name="creyPY",
     version=get_latest_git_tag(),
-    description="My collection of Python and FastAPI shortcuts etc.",
+    description="Collection of my Python and FastAPI shortcuts, snippets etc.",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
     author="Conrad Großer",
     author_email="conrad@noah.tech",
     packages=find_packages(),
@@ -31,4 +33,14 @@ setup(
     license="MIT",
     python_requires=">=3.12",
     install_requires=requirements,
+    keywords=[
+        "creyPY",
+        "Python",
+        "FastAPI",
+        "shortcuts",
+        "snippets",
+        "utils",
+        "personal library",
+    ],
+    platforms="any",
 )

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()