yama-client 0.1.0__tar.gz

yama_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yama Access Software Systems Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yama_client-0.1.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: yama-client
+Version: 0.1.0
+Summary: The official Python client for the Yama access-control API
+Keywords: yama,access control,intercom,api,client
+Author: Yama Access Software Systems Ltd.
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.7
+Requires-Python: >=3.10
+Project-URL: Homepage, https://yamasystems.com
+Project-URL: Documentation, https://yass-ltd.github.io/yama-python/
+Project-URL: Source, https://github.com/YASS-Ltd/yama-python
+Project-URL: Issues, https://github.com/YASS-Ltd/yama-python/issues
+Project-URL: Release notes, https://github.com/YASS-Ltd/yama-python/releases
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset=".github/assets/yama-logo-dark.svg">
+    <img src=".github/assets/yama-logo-light.svg" alt="Yama" width="280">
+  </picture>
+</p>
+
+<p align="center">
+  <em>The official Python client for the Yama access-control API.</em>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/yama-client/"><img src="https://img.shields.io/pypi/v/yama-client?style=flat-square" alt="PyPI"></a>
+  <a href="https://pypi.org/project/yama-client/"><img src="https://img.shields.io/pypi/pyversions/yama-client?style=flat-square" alt="Python versions"></a>
+  <a href="https://github.com/YASS-Ltd/yama-python/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/YASS-Ltd/yama-python/ci.yml?branch=main&style=flat-square&label=CI" alt="CI"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/licence-MIT-21212B?style=flat-square" alt="MIT licence"></a>
+</p>
+
+---
+
+**Docs:** <https://yass-ltd.github.io/yama-python/> · **REST API:** <https://app.yamasystems.com/api/v2/docs/> · **Source:** <https://github.com/YASS-Ltd/yama-python>
+
+---
+
+Manage a building's access codes and read its call log from Python. The client handles auth, pagination, retries and errors, and gives you typed objects back.
+
+> [!NOTE]
+> **In development.** Nothing is on PyPI yet. Until then, use the [REST API](https://app.yamasystems.com/api/v2/docs/) directly.
+
+## Install
+
+```console
+uv add yama-client  # or: pip install yama-client
+```
+
+<!-- --8<-- [start:quick-start] -->
+## Quick start
+
+Create an API key in the Yama portal under **Settings › API keys**, with read access to access codes and the call log, and set it as `YAMA_API_KEY`. Keep it out of source control.
+
+```python
+from datetime import datetime, timezone
+
+from yama import Yama
+
+client = Yama()  # reads YAMA_API_KEY
+
+for code in client.codes.list():
+    print(code.name, code.expires_at)
+
+start = datetime(2026, 10, 1, tzinfo=timezone.utc)
+end = datetime(2026, 11, 1, tzinfo=timezone.utc)  # exclusive: all of October
+for call in client.calls.list(start=start, end=end):
+    print(call.started_at, call.result)
+```
+<!-- --8<-- [end:quick-start] -->
+
+## What you get
+
+- **Typed:** Pydantic models with UTC-aware datetimes, so your editor autocompletes.
+- **Every item:** iterating a list yields every item, and each call in the call log comes once.
+- **Safe retries:** on 429 (honouring `Retry-After`), 5xx and network errors, for every call, creates included: a code is never created twice.
+- **Clear errors:** one exception class per kind of failure, listed in the [docs](https://yass-ltd.github.io/yama-python/errors/).
+- **Forward-compatible:** new fields and enum values from the API don't break your code.
+- **Small:** two dependencies, httpx and Pydantic. Python 3.10 and newer.
+
+## Versioning
+
+SemVer, targeting version 2 of the Yama API (`/api/v2/`). Release notes are on [GitHub Releases](https://github.com/YASS-Ltd/yama-python/releases).
+
+## Contributing
+
+Bug reports and ideas are welcome in [issues](https://github.com/YASS-Ltd/yama-python/issues). Development uses [uv](https://docs.astral.sh/uv/) and [just](https://just.systems/): `just check` runs everything CI does. Report security issues privately; see [SECURITY.md](SECURITY.md).
+
+## Licence
+
+[MIT](LICENSE) © Yama Access Software Systems Ltd.

yama_client-0.1.0/README.md

@@ -0,0 +1,77 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset=".github/assets/yama-logo-dark.svg">
+    <img src=".github/assets/yama-logo-light.svg" alt="Yama" width="280">
+  </picture>
+</p>
+
+<p align="center">
+  <em>The official Python client for the Yama access-control API.</em>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/yama-client/"><img src="https://img.shields.io/pypi/v/yama-client?style=flat-square" alt="PyPI"></a>
+  <a href="https://pypi.org/project/yama-client/"><img src="https://img.shields.io/pypi/pyversions/yama-client?style=flat-square" alt="Python versions"></a>
+  <a href="https://github.com/YASS-Ltd/yama-python/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/YASS-Ltd/yama-python/ci.yml?branch=main&style=flat-square&label=CI" alt="CI"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/licence-MIT-21212B?style=flat-square" alt="MIT licence"></a>
+</p>
+
+---
+
+**Docs:** <https://yass-ltd.github.io/yama-python/> · **REST API:** <https://app.yamasystems.com/api/v2/docs/> · **Source:** <https://github.com/YASS-Ltd/yama-python>
+
+---
+
+Manage a building's access codes and read its call log from Python. The client handles auth, pagination, retries and errors, and gives you typed objects back.
+
+> [!NOTE]
+> **In development.** Nothing is on PyPI yet. Until then, use the [REST API](https://app.yamasystems.com/api/v2/docs/) directly.
+
+## Install
+
+```console
+uv add yama-client  # or: pip install yama-client
+```
+
+<!-- --8<-- [start:quick-start] -->
+## Quick start
+
+Create an API key in the Yama portal under **Settings › API keys**, with read access to access codes and the call log, and set it as `YAMA_API_KEY`. Keep it out of source control.
+
+```python
+from datetime import datetime, timezone
+
+from yama import Yama
+
+client = Yama()  # reads YAMA_API_KEY
+
+for code in client.codes.list():
+    print(code.name, code.expires_at)
+
+start = datetime(2026, 10, 1, tzinfo=timezone.utc)
+end = datetime(2026, 11, 1, tzinfo=timezone.utc)  # exclusive: all of October
+for call in client.calls.list(start=start, end=end):
+    print(call.started_at, call.result)
+```
+<!-- --8<-- [end:quick-start] -->
+
+## What you get
+
+- **Typed:** Pydantic models with UTC-aware datetimes, so your editor autocompletes.
+- **Every item:** iterating a list yields every item, and each call in the call log comes once.
+- **Safe retries:** on 429 (honouring `Retry-After`), 5xx and network errors, for every call, creates included: a code is never created twice.
+- **Clear errors:** one exception class per kind of failure, listed in the [docs](https://yass-ltd.github.io/yama-python/errors/).
+- **Forward-compatible:** new fields and enum values from the API don't break your code.
+- **Small:** two dependencies, httpx and Pydantic. Python 3.10 and newer.
+
+## Versioning
+
+SemVer, targeting version 2 of the Yama API (`/api/v2/`). Release notes are on [GitHub Releases](https://github.com/YASS-Ltd/yama-python/releases).
+
+## Contributing
+
+Bug reports and ideas are welcome in [issues](https://github.com/YASS-Ltd/yama-python/issues). Development uses [uv](https://docs.astral.sh/uv/) and [just](https://just.systems/): `just check` runs everything CI does. Report security issues privately; see [SECURITY.md](SECURITY.md).
+
+## Licence
+
+[MIT](LICENSE) © Yama Access Software Systems Ltd.

yama_client-0.1.0/pyproject.toml

@@ -0,0 +1,95 @@
+[project]
+name = "yama-client"
+version = "0.1.0"
+description = "The official Python client for the Yama access-control API"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+dependencies = [
+    "httpx>=0.27",
+    "pydantic>=2.7",
+]
+keywords = [
+    "yama",
+    "access control",
+    "intercom",
+    "api",
+    "client",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
+]
+
+[[project.authors]]
+name = "Yama Access Software Systems Ltd."
+
+[project.urls]
+Homepage = "https://yamasystems.com"
+Documentation = "https://yass-ltd.github.io/yama-python/"
+Source = "https://github.com/YASS-Ltd/yama-python"
+Issues = "https://github.com/YASS-Ltd/yama-python/issues"
+"Release notes" = "https://github.com/YASS-Ltd/yama-python/releases"
+
+[dependency-groups]
+dev = [
+    "mkdocstrings-python>=2.0.9",
+    "mypy>=1.13",
+    "openapi-schema-validator>=0.9.0",
+    "pymdown-extensions<12; python_version < '3.11'",
+    "pytest>=8",
+    "pytest-cov>=6",
+    "pyyaml>=6.0.3",
+    "respx>=0.22",
+    "ruff>=0.8",
+    "types-jsonschema>=4.26.0.20261006",
+    "types-pyyaml>=6.0.12.20260906",
+    "zensical>=0.0.67",
+]
+
+[build-system]
+requires = ["uv_build>=0.11.29,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "yama"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "W",
+    "I",
+    "UP",
+    "B",
+    "SIM",
+    "RUF",
+]
+
+[tool.mypy]
+strict = true
+python_version = "3.10"
+plugins = ["pydantic.mypy"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+]
+xfail_strict = true
+filterwarnings = ["error"]
+markers = ["live: runs against a real Yama API (just test-live)"]
+
+[tool.coverage.run]
+source = ["yama"]
+branch = true

yama_client-0.1.0/pyproject.toml.orig

@@ -0,0 +1,76 @@
+[project]
+name = "yama-client"
+version = "0.1.0"
+description = "The official Python client for the Yama access-control API"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Yama Access Software Systems Ltd." }]
+requires-python = ">=3.10"
+dependencies = [
+    "httpx>=0.27",
+    "pydantic>=2.7",
+]
+keywords = ["yama", "access control", "intercom", "api", "client"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://yamasystems.com"
+Documentation = "https://yass-ltd.github.io/yama-python/"
+Source = "https://github.com/YASS-Ltd/yama-python"
+Issues = "https://github.com/YASS-Ltd/yama-python/issues"
+"Release notes" = "https://github.com/YASS-Ltd/yama-python/releases"
+
+[dependency-groups]
+dev = [
+    "mkdocstrings-python>=2.0.9",
+    "mypy>=1.13",
+    "openapi-schema-validator>=0.9.0",
+    # mkdocstrings for Python 3.10 (1.0.6) can't highlight with pymdown-extensions 12.
+    "pymdown-extensions<12; python_version < '3.11'",
+    "pytest>=8",
+    "pytest-cov>=6",
+    "pyyaml>=6.0.3",
+    "respx>=0.22",
+    "ruff>=0.8",
+    "types-jsonschema>=4.26.0.20261006",
+    "types-pyyaml>=6.0.12.20260906",
+    "zensical>=0.0.67",
+]
+
+[build-system]
+requires = ["uv_build>=0.11.29,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "yama"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.mypy]
+strict = true
+python_version = "3.10"
+plugins = ["pydantic.mypy"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["--strict-markers", "--strict-config"]
+xfail_strict = true
+filterwarnings = ["error"]
+markers = ["live: runs against a real Yama API (just test-live)"]
+
+[tool.coverage.run]
+source = ["yama"]
+branch = true

yama_client-0.1.0/src/yama/__init__.py

@@ -0,0 +1,82 @@
+"""The official Python client for the Yama API."""
+
+import logging
+from importlib.metadata import version
+
+from yama._client import DEFAULT_BASE_URL, Yama
+from yama._errors import (
+    APIConnectionError,
+    APIStatusError,
+    APITimeoutError,
+    AuthenticationError,
+    BadRequestError,
+    ConflictError,
+    GoneError,
+    NotFoundError,
+    PermissionDeniedError,
+    RateLimitError,
+    ServerError,
+    UnprocessableEntityError,
+    YamaError,
+)
+from yama.models import (
+    AccessCode,
+    AccessCodeCreate,
+    AccessCodeUpdate,
+    AccessLevel,
+    ApiKeyDetails,
+    ApiKeyPermissions,
+    ApiKeyUnitAccess,
+    Building,
+    CallLogEntry,
+    CallLogStep,
+    CallResult,
+    CallStepKind,
+    CodeAttemptResult,
+    Contact,
+    DialStatus,
+    DoorDigit,
+    Unit,
+    UnitAccessType,
+)
+
+__version__ = version("yama-client")
+
+logging.getLogger("yama").addHandler(logging.NullHandler())
+
+__all__ = [
+    "DEFAULT_BASE_URL",
+    "APIConnectionError",
+    "APIStatusError",
+    "APITimeoutError",
+    "AccessCode",
+    "AccessCodeCreate",
+    "AccessCodeUpdate",
+    "AccessLevel",
+    "ApiKeyDetails",
+    "ApiKeyPermissions",
+    "ApiKeyUnitAccess",
+    "AuthenticationError",
+    "BadRequestError",
+    "Building",
+    "CallLogEntry",
+    "CallLogStep",
+    "CallResult",
+    "CallStepKind",
+    "CodeAttemptResult",
+    "ConflictError",
+    "Contact",
+    "DialStatus",
+    "DoorDigit",
+    "GoneError",
+    "NotFoundError",
+    "PermissionDeniedError",
+    "RateLimitError",
+    "ServerError",
+    "Unit",
+    "UnitAccessType",
+    "UnprocessableEntityError",
+    "Yama",
+    "YamaError",
+    "__version__",
+]