Minor bugfix

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Lint and tag
+name: Lint, Test, Tag & Publish
 
 on:
   push:
@@ -10,6 +10,7 @@ on:
       - "**/.vscode/**"
       - "**/README.md"
       - "**/CHANGELOG.md"
+  workflow_dispatch:
 
 jobs:
   lint:
@@ -39,27 +40,51 @@ jobs:
       - run: python -m pip install -r requirements.txt
       - run: python test.py
 
-  tag:
+  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 "actions@github.com"
-          git config --local user.name "GitHub Action"
+          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:
-          prefix: v
           minor-identifier: "feat:"
           major-identifier: "breaking:"
 
       - name: Create Tag
-        run: git tag -a ${{ steps.git_version.outputs.version }} -m "${{ steps.git_version.outputs.version }}"
+        run: git tag ${{ steps.git_version.outputs.version }}
 
-      - name: Push Tag
+      - 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/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,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 0.2.0
+
+- Added testing client

README.md

@@ -1,2 +1,3 @@
 # creyPY
+
 My collection of Python and FastAPI shortcuts etc.

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/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

setup.py

@@ -24,6 +24,8 @@ setup(
     name="creyPY",
     version=get_latest_git_tag(),
     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",
 )