Feature/update documentation (#6)

- Update automation schedule and Python version in workflows
- Add some example code to the documentation
- Ditch Python version 3.9

Author: josteinl

.github/workflows/auto-update.yaml

@@ -2,7 +2,7 @@ name: Auto Update from OpenAPI Spec
 
 on:
   schedule:
-    - cron: "0 4 * * *" # 04:00 UTC daily
+    - cron: "0 4,10,12,14 * * MON-FRI" # Every two hours 4-14 UTC Monday to Friday
   workflow_dispatch:
 
 permissions:
@@ -29,7 +29,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: '3.13'
 
       - name: Install generator
         run: |
@@ -92,9 +92,9 @@ jobs:
         if: steps.download.outputs.changed == 'true'
         uses: peter-evans/create-pull-request@v6
         with:
-          commit-message: "chore: update OpenAPI spec to version ${{ steps.regenerate.outputs.updated_version }}"
+          commit-message: "Update OpenAPI spec to version ${{ steps.regenerate.outputs.updated_version }}"
           branch: chore/openapi-spec-v${{ steps.regenerate.outputs.updated_version }}
-          title: "chore: update OpenAPI spec to version ${{ steps.regenerate.outputs.updated_version }}"
+          title: "Update OpenAPI spec to version ${{ steps.regenerate.outputs.updated_version }}"
           body: |
             Automated update for OpenAPI spec version `${{ steps.regenerate.outputs.updated_version }}`.
 
@@ -104,7 +104,7 @@ jobs:
             - Bumped package version in pyproject.toml
 
             After merging this PR, create a GitHub Release (tag `v${{ steps.regenerate.outputs.updated_version }}`) to trigger the publish workflow.
-          labels: automated, openapi, chore
+          labels: automated, openapi
           signoff: false
           draft: false
           delete-branch: false

MAINTAINERS_GUIDE.md

@@ -1,16 +1,18 @@
 # Maintainers Guide
 
+This procedure is not automated and run regularly in github. If the source OpenAPI file has changed, a PR is created. 
+You only need to create a new release in GitHub to publish the new version to PyPi.
+
 See the [Makefile](./Makefile) if you need to install and test locally. Just type `make` to get the help.
 
 Or just follow these steps:
 
 ## For new API version
 
-1. Copy and rename the openapi.yaml the `openapi_specification/nadag-innmelding.yaml`
-2. Update the version number in the `config.yaml` file 
-3. Run the following command to generate the client code:
+1. Copy and rename the source openapi file the `openapi_specification/nadag-innmelding.yaml`
+2. Run the following command to generate the client code:
    ```bash
     uvx openapi-python-client generate --path openapi_specification/nadag-innmelding.yaml --overwrite --custom-template-path=templates --config config.yaml
     ```
-4. Check in the changes to the repository (files updated, added, or removed).
-5. In the GitHub project, create a new release and the package should be published to PyPi.
+3. Check in the changes to the repository (files updated, added, or removed).
+4. In the GitHub project, create a new release and the package should be published to PyPi.

README.md

@@ -18,7 +18,32 @@ pip install nadag-innmelding-python-client
 ## Usage
 
 ```python
-
+from nadag_innmelding_python_client import AuthenticatedClient
+from nadag_innmelding_python_client.api.default import get_nadag_innmelding_v_1_geoteknisk_unders as get_geoteknisk_unders
+from nadag_innmelding_python_client.models import GeotekniskUnders
+from nadag_innmelding_python_client.types import Response
+
+secret_token = nadag_authenticate() # This you need to implement this yourself
+
+client = AuthenticatedClient(
+    base_url="https://test.ngu.no/api/",
+    token=secret_token,
+)
+
+response: Response[GeotekniskUnders] = get_geoteknisk_unders.sync_detailed(
+    client=client,
+    ekstern_id=str(project_id),
+    ekstern_navnerom="Your Namespace",
+)
+
+match response.status_code:
+    case HTTPStatus.OK:
+        geoteknisk_unders: GeotekniskUnders = response.parsed
+    case HTTPStatus.NOT_FOUND:
+        # Create a new project in NADAG
+    case _:
+        # Handle other status codes
+        raise Exception(f"Got unexpected status code {response.status_code} for project ")
 ```
 
 ## Automation: keeping the client in sync with upstream OpenAPI

templates/pyproject.toml.jinja

@@ -10,7 +10,7 @@ description = "{{ package_description }}"
 authors = ["Jiyang Ye <jiyang[email protected]>"]
 maintainers = ["Jiyang Ye <jiyang[email protected]>", "Jostein Leira <jostein[email protected]>"]
 readme = "README.md"
-{% if pdm %}requires-python = ">=3.9,<4.0"{% endif %}
+{% if pdm %}requires-python = ">=3.10,<4.0"{% endif %}
 {% if poetry %}
 packages = [
     {include = "{{ package_name }}"},
@@ -31,7 +31,7 @@ distribution = true
 {% if poetry %}
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.13"
 httpx = ">=0.20.0,<0.29.0"
 attrs = ">=22.2.0"
 python-dateutil = "^2.8.0"