fix: fixed a bug with the jsonschema for order_by

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.1.0
+
+- Added headers to testing
+
+## 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

README.md

@@ -1,3 +1,62 @@
 # creyPY
 
 My collection of Python and FastAPI shortcuts etc.
+
+## Installation
+
+```bash
+pip install creyPY -U
+```
+
+## Versioning
+
+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
+- Add version without postgresql dependency

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

@@ -36,7 +36,7 @@ def update_obj_from_data(
     model: Type[T],
     id: UUID | str,
     db: Session,
-    partial: bool = False,
+    partial: bool = False,  # TODO: inverse, because it is currently the wrong way around
     ignore_fields=[],
     additional_data={},
     exclude={},

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/order_by.py

@@ -0,0 +1,15 @@
+from typing import Callable
+
+from pydantic.json_schema import SkipJsonSchema
+from sqlalchemy import asc, desc
+from sqlalchemy.sql.selectable import Select
+
+
+def order_by(order_by: str | SkipJsonSchema[None] = None) -> Callable[[Select], Select]:
+    def _order_by(query: Select) -> Select:
+        if order_by:
+            direction = desc if order_by.startswith("-") else asc
+            query = query.order_by(direction(order_by.lstrip("-")))
+        return query
+
+    return _order_by

creyPY/fastapi/testing.py

@@ -6,26 +6,31 @@ from fastapi.testclient import TestClient
 class GenericClient(TestClient):
     def __init__(self, client):
         self.c = TestClient(client)
+        self.default_headers = {}
 
     def get(self, url: str, r_code: int = 200, parse_json=True):
-        re = self.c.get(url)
+        re = self.c.get(url, headers=self.default_headers)
         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)
+        re = self.c.delete(url, headers=self.default_headers)
         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
+        self, url: str, obj: dict | str = {}, 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
+            url,
+            data=json.dumps(obj) if type(obj) == dict else obj,
+            headers=self.default_headers | {"Content-Type": "application/json"},
+            *args,
+            **kwargs,
         )
         if re.status_code != r_code:
             print(re.content)
@@ -33,28 +38,41 @@ class GenericClient(TestClient):
         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
+        re = self.c.post(
+            url,
+            files={"file": file},
+            headers=self.default_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):
+    def patch(
+        self, url: str, obj: dict | str = {}, r_code: int = 200, raw_response=False, *args, **kwargs
+    ):
+        re = self.c.patch(
+            url,
+            data=json.dumps(obj) if type(obj) == dict else obj,
+            headers=self.default_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 | str = {}, r_code: int = 200, raw_response=False, *args, **kwargs
+    ):
         re = self.c.put(
             url,
-            data=json.dumps(obj),
-            headers={
+            data=json.dumps(obj) if type(obj) == dict else obj,
+            headers=self.default_headers
+            | {
                 "Content-Type": "application/json",
                 "accept": "application/json",
             },
@@ -66,7 +84,14 @@ class GenericClient(TestClient):
         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):
+    def obj_lifecycle(
+        self,
+        input_obj: dict,
+        url: str,
+        pagination: bool = True,
+        id_field: str = "id",
+        created_at_check: bool = True,
+    ):
         # GET LIST
         re = self.get(url)
         if pagination:
@@ -77,15 +102,18 @@ class GenericClient(TestClient):
 
         # 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
+        assert id_field in re
+        assert re[id_field] is not None
 
-        obj_id = str(re["id"])
+        if created_at_check:
+            assert "created_at" in re
+            assert re["created_at"] is not None
+
+        obj_id = str(re[id_field])
 
         # GET
         re = self.get(f"{url}{obj_id}/")
-        assert re["id"] == obj_id
+        assert re[id_field] == obj_id
 
         # GET LIST
         re = self.get(url)

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