Generate client

.github/workflows/formatting_and_linting.yml

@@ -1,4 +1,5 @@
 ---
+name: Formatting and Linting
 on:
   push:
     branches-ignore:

.github/workflows/generate-client.yml

@@ -0,0 +1,66 @@
+name: Generate API Client
+
+on: push
+
+permissions:
+  contents: write
+
+jobs:
+  generate-client:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: fia
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v3.5.0
+
+      - name: Set up Python
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v4.5.0
+        with:
+          python-version: "3.12"
+
+      - name: Set up cache for Python dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install API dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .
+
+      - name: Install client generation dependencies
+        run: |
+          python -m pip install ".[client-generation]"
+
+      - name: Start FIA API in background
+        run: |
+          uvicorn fia_api.fia_api:app --host 0.0.0.0 --port 8000 &
+          # Wait for API to start
+          sleep 10
+
+      - name: Generate client code
+        run: |
+          openapi-python-client generate --url http://localhost:8000/openapi.json --overwrite
+
+
+      - name: Commit changes
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add fia_api_client/
+          git commit -m "Update API client based on latest OpenAPI schema" || echo "No changes to commit"
+          git push

.github/workflows/test-generated-client.yml

@@ -0,0 +1,65 @@
+---
+name: Run Tests on Autogenerated Client
+on: push
+
+permissions:
+  contents: read
+  packages: read
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:14.7
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: fia
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v3.5.0
+
+      - name: Set up python
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v4.5.0
+        with:
+          python-version: "3.12"
+
+      - name: Set up cache for Python dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies.
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .[test]
+
+      - name: Install client generation dependencies
+        run: | 
+          python -m pip install ".[client-generation]"
+
+      - name: Start FIA API in background
+        run: |
+          uvicorn fia_api.fia_api:app --host 0.0.0.0 --port 8000 &
+          # Wait for API to start
+          sleep 10
+
+      - name: Generate client code
+        run: |
+          openapi-python-client generate --url http://localhost:8000/openapi.json --overwrite
+
+      - name: Run pytest
+        env:
+          DATABASE_URL: postgresql://postgres:password@localhost:5432/test_db
+          GITHUB_PACKAGE_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: pytest test/core/test_autogenerated_client.py
+
+

.github/workflows/tests.yml

@@ -1,12 +1,13 @@
 ---
+name: Run Tests
 on: push
 
 permissions:
   contents: read
   packages: read
 
 jobs:
-  pytest:
+  Unit-Tests:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout project
@@ -30,14 +31,14 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install .[test]
       - name: Run pytest
-        run: pytest . --random-order --random-order-bucket=global --ignore=test/e2e --ignore=test/core/test_repositories_integration.py --cov --cov-report=xml
+        run: pytest . --random-order --random-order-bucket=global --ignore=test/e2e --ignore=test/core/test_repositories_integration.py --ignore=test/core/test_autogenerated_client.py --cov --cov-report=xml
 
       - name: Upload coverage
         uses: codecov/codecov-action@fdcc8476540edceab3de004e990f80d881c6cc00 # v5.5.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 
-  integration:
+  Integration-Tests:
     runs-on: ubuntu-latest
 
     services:

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "fia_api_client"]
+	path = fia_api_client
+	url = https://github.com/fiaisis/fia_api_client.git

fia-api-client/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage

fia-api-client/README.md

@@ -0,0 +1,124 @@
+# fia-api-client
+A client library for accessing FIA API
+
+## Usage
+First, create a client:
+
+```python
+from fia_api_client import Client
+
+client = Client(base_url="https://api.example.com")
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from fia_api_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from fia_api_client.models import MyDataModel
+from fia_api_client.api.my_tag import get_my_data_model
+from fia_api_client.types import Response
+
+with client as client:
+    my_data: MyDataModel = get_my_data_model.sync(client=client)
+    # or if you need more info (e.g. status_code)
+    response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+```
+
+Or do the same thing with an async version:
+
+```python
+from fia_api_client.models import MyDataModel
+from fia_api_client.api.my_tag import get_my_data_model
+from fia_api_client.types import Response
+
+async with client as client:
+    my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
+    response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken",
+    verify_ssl="/path/to/certificate_bundle.pem",
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken", 
+    verify_ssl=False
+)
+```
+
+Things to know:
+1. Every path/method combo becomes a Python module with four functions:
+    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+    1. `asyncio`: Like `sync` but async instead of blocking
+    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `fia_api_client.api.default`
+
+## Advanced customizations
+
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from fia_api_client import Client
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+client = Client(
+    base_url="https://api.example.com",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import httpx
+from fia_api_client import Client
+
+client = Client(
+    base_url="https://api.example.com",
+)
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030"))
+```
+
+## Building / publishing this package
+This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
+1. Update the metadata in pyproject.toml (e.g. authors, version)
+1. If you're using a private repository, configure it with Poetry
+    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
+    1. `poetry config http-basic.<your-repository-name> <username> <password>`
+1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
+
+If you want to install this client into another project without publishing it (e.g. for development) then:
+1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
+1. If that project is not using Poetry:
+    1. Build a wheel with `poetry build -f wheel`
+    1. Install that wheel from the other project `pip install <path-to-wheel>`

fia-api-client/fia_api_client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing FIA API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

fia-api-client/fia_api_client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

fia-api-client/fia_api_client/api/files/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""