yertle-client 0.1.0__tar.gz

yertle_client-0.1.0/.gitignore

@@ -0,0 +1,238 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+*.pem
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+.claude/worktrees/
+.claude/launch.json
+.claude/next-worktree-port
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+
+# Environment files strategy:
+# .env.dev, .env.prod - Generated by CLI (make update-env ENV=xxx), tracked in git
+# .env.local - Local development only, not tracked in git  
+# .env* - Other temporary environment files, not tracked in git
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+pretty.output
+
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+frontend/coverage/
+
+frontend/node_modules/
+
+backend/.aws-sam/
+
+
+set_vars.sh
+
+.obsidian/
+backend/layers/aurora-db/python/
+backend/layers/postgresql-db/python
+
+secrets.sh
+
+backend/local/users.json
+backend/layers/postgresql-db/postgresql-layer.zip
+
+
+# Supabase migrations are tracked in version control
+# (No auto-generated files to ignore)
+
+deployment/prod.yaml
+backend/src/config/environments/prod.yaml
+
+# Go CLI
+cli/yertle
+cli/dist/

yertle_client-0.1.0/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.5
+Name: yertle-client
+Version: 0.1.0
+Summary: Auto-generated Python client for the Yertle API.
+Project-URL: Homepage, https://github.com/model-context/yertle-python
+Project-URL: Repository, https://github.com/model-context/yertle-python
+Author: Yertle
+License: MIT
+Keywords: api,client,yertle
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Requires-Dist: attrs>=23.2
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: python-dateutil>=2.8
+Description-Content-Type: text/markdown
+
+# yertle-client
+
+Auto-generated Python client for the [Yertle](https://yertle.com) API.
+
+> **Status:** alpha (`0.0.1`). Generated with [`openapi-python-client`](https://github.com/openapi-generators/openapi-python-client) from the backend's OpenAPI spec.
+
+## Install
+
+```bash
+# Not yet on PyPI. Install from this repo:
+pip install -e clients/python/
+```
+
+## Usage
+
+```python
+from yertle_client.auth import client_from_token
+from yertle_client.api.organizations import list_organizations_orgs_get
+
+client = client_from_token(
+    token="<JWT or PAT>",
+    base_url="https://api.yertle.com",
+)
+orgs = list_organizations_orgs_get.sync(client=client)
+for org in orgs or []:
+    print(org.id, org.name)
+```
+
+The package re-exports `Client` and `AuthenticatedClient` from the top level for direct use, but `client_from_token` is the recommended entry point.
+
+## Regeneration
+
+```bash
+./generate.sh                                                 # dump from local backend, then regen
+OPENAPI_PATH=/path/to/spec.json ./generate.sh                 # use a local spec file
+OPENAPI_URL=http://localhost:8000/openapi.json ./generate.sh  # fetch from a running backend
+```
+
+## Layout
+
+| Path | Source | Notes |
+|---|---|---|
+| `yertle_client/api/` | generated | one module per API route |
+| `yertle_client/models/` | generated | request/response models (attrs-based) |
+| `yertle_client/client.py` | generated | `Client` and `AuthenticatedClient` |
+| `yertle_client/auth.py` | **hand-written** | `client_from_token` helper. May be wiped by regeneration — restore from git. |
+| `openapi-config.yaml` | hand-written | codegen options (package name, naming) |
+| `generate.sh` | hand-written | regeneration script |

yertle_client-0.1.0/README.md

@@ -0,0 +1,48 @@
+# yertle-client
+
+Auto-generated Python client for the [Yertle](https://yertle.com) API.
+
+> **Status:** alpha (`0.0.1`). Generated with [`openapi-python-client`](https://github.com/openapi-generators/openapi-python-client) from the backend's OpenAPI spec.
+
+## Install
+
+```bash
+# Not yet on PyPI. Install from this repo:
+pip install -e clients/python/
+```
+
+## Usage
+
+```python
+from yertle_client.auth import client_from_token
+from yertle_client.api.organizations import list_organizations_orgs_get
+
+client = client_from_token(
+    token="<JWT or PAT>",
+    base_url="https://api.yertle.com",
+)
+orgs = list_organizations_orgs_get.sync(client=client)
+for org in orgs or []:
+    print(org.id, org.name)
+```
+
+The package re-exports `Client` and `AuthenticatedClient` from the top level for direct use, but `client_from_token` is the recommended entry point.
+
+## Regeneration
+
+```bash
+./generate.sh                                                 # dump from local backend, then regen
+OPENAPI_PATH=/path/to/spec.json ./generate.sh                 # use a local spec file
+OPENAPI_URL=http://localhost:8000/openapi.json ./generate.sh  # fetch from a running backend
+```
+
+## Layout
+
+| Path | Source | Notes |
+|---|---|---|
+| `yertle_client/api/` | generated | one module per API route |
+| `yertle_client/models/` | generated | request/response models (attrs-based) |
+| `yertle_client/client.py` | generated | `Client` and `AuthenticatedClient` |
+| `yertle_client/auth.py` | **hand-written** | `client_from_token` helper. May be wiped by regeneration — restore from git. |
+| `openapi-config.yaml` | hand-written | codegen options (package name, naming) |
+| `generate.sh` | hand-written | regeneration script |

yertle_client-0.1.0/generate.sh

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# Regenerate yertle_client/ from the backend's OpenAPI spec.
+#
+# Spec source priority:
+#   1. $OPENAPI_URL  — fetch from URL (e.g. a running backend or live API)
+#   2. $OPENAPI_PATH — read from a local JSON file
+#   3. (default)     — dump from the local backend via Python import
+#
+# Hand-written files inside yertle_client/ (currently: auth.py) may be
+# removed during regeneration. Restore them from git afterwards:
+#   git checkout yertle_client/auth.py
+
+set -euo pipefail
+cd "$(dirname "$0")"
+
+if [[ -n "${OPENAPI_URL:-}" ]]; then
+    SRC_ARG="--url ${OPENAPI_URL}"
+elif [[ -n "${OPENAPI_PATH:-}" ]]; then
+    SRC_ARG="--path ${OPENAPI_PATH}"
+else
+    echo "→ Dumping OpenAPI spec from local backend..."
+    TMPSPEC="$(mktemp -t yertle-openapi.XXXXXX.json)"
+    # cd into backend/ (not repo root) so `from src.api.app import ...` resolves.
+    # `src` is a package inside backend/, not at the repo root.
+    pushd ../../backend > /dev/null
+    pipenv run python -c "
+from src.api.app import create_app
+import json, sys
+json.dump(create_app().openapi(), sys.stdout)
+" > "$TMPSPEC"
+    popd > /dev/null
+    SRC_ARG="--path ${TMPSPEC}"
+fi
+
+echo "→ Running openapi-python-client..."
+uvx --from openapi-python-client openapi-python-client generate \
+    ${SRC_ARG} \
+    --output-path yertle_client \
+    --meta none \
+    --config openapi-config.yaml \
+    --overwrite
+
+echo
+echo "✓ Done. If auth.py was removed, restore it: git checkout yertle_client/auth.py"

yertle_client-0.1.0/openapi-config.yaml

@@ -0,0 +1,3 @@
+project_name_override: "yertle-client"
+package_name_override: "yertle_client"
+use_path_prefixes_for_title_model_names: false

yertle_client-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "yertle-client"
+version = "0.1.0"
+description = "Auto-generated Python client for the Yertle API."
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+authors = [{ name = "Yertle" }]
+keywords = ["yertle", "api", "client"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "httpx>=0.27,<1",
+    "attrs>=23.2",
+    "python-dateutil>=2.8",
+]
+
+[project.urls]
+Homepage = "https://github.com/model-context/yertle-python"
+Repository = "https://github.com/model-context/yertle-python"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["yertle_client"]

yertle_client-0.1.0/yertle_client/__init__.py

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

yertle_client-0.1.0/yertle_client/api/__init__.py

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

yertle_client-0.1.0/yertle_client/api/authentication/__init__.py

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

yertle_client-0.1.0/yertle_client/api/authentication/refresh_token_auth_refresh_post.py

@@ -0,0 +1,174 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...models.refresh_token_request import RefreshTokenRequest
+from ...models.refresh_token_response import RefreshTokenResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: RefreshTokenRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/auth/refresh",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | RefreshTokenResponse | None:
+    if response.status_code == 200:
+        response_200 = RefreshTokenResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[HTTPValidationError | RefreshTokenResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: RefreshTokenRequest,
+) -> Response[HTTPValidationError | RefreshTokenResponse]:
+    """Refresh Token
+
+     Refresh an access token using a refresh token.
+
+    Args:
+        body (RefreshTokenRequest): Request model for token refresh.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[HTTPValidationError | RefreshTokenResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: RefreshTokenRequest,
+) -> HTTPValidationError | RefreshTokenResponse | None:
+    """Refresh Token
+
+     Refresh an access token using a refresh token.
+
+    Args:
+        body (RefreshTokenRequest): Request model for token refresh.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        HTTPValidationError | RefreshTokenResponse
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: RefreshTokenRequest,
+) -> Response[HTTPValidationError | RefreshTokenResponse]:
+    """Refresh Token
+
+     Refresh an access token using a refresh token.
+
+    Args:
+        body (RefreshTokenRequest): Request model for token refresh.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[HTTPValidationError | RefreshTokenResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: RefreshTokenRequest,
+) -> HTTPValidationError | RefreshTokenResponse | None:
+    """Refresh Token
+
+     Refresh an access token using a refresh token.
+
+    Args:
+        body (RefreshTokenRequest): Request model for token refresh.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        HTTPValidationError | RefreshTokenResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed