glpi-python-client 0.1.0__tar.gz

glpi_python_client-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+# Bytecode and caches
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Packaging
+build/
+dist/
+*.egg-info/
+docs/_build/
+
+# Virtual environments
+.venv/
+venv/
+
+# Local configuration
+.env
+.env.*
+
+*.pyc
+dist/
+.venv/
+
+secrets/
+secrets/*
+
+integration_tests/
+integration_tests/*

glpi_python_client-0.1.0/.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

glpi_python_client-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Thank you for improving `glpi-python-client`.
+
+## Development Setup
+
+```bash
+python -m venv .venv
+.venv\Scripts\activate
+python -m pip install -e .[dev]
+python -m pytest
+```
+
+## Quality Checks
+
+Run the focused checks before opening a pull request:
+
+```bash
+python -m pytest
+python -m ruff check .
+python -m mypy glpi_python_client
+```
+
+## Documentation build
+
+To build the documentation locally:
+
+```bash
+python -m sphinx -W --keep-going -b html docs docs/_build/html pa
+```
+
+## GitHub Actions
+
+- `.github/workflows/ci.yml` runs tests for Python 3.10 through 3.13 on pull
+  requests and pushes to `main`.
+- The same workflow runs `ruff`, `mypy`, and a warning-free Sphinx build on
+  Python 3.12.
+- When `READTHEDOCS_TOKEN` and `READTHEDOCS_PROJECT` are configured as GitHub
+  secrets, pushes to `main` also trigger the Read the Docs `latest` build.
+- `.github/workflows/release.yml` repeats the checks for published releases,
+  builds the distribution artifacts, and triggers the configured release docs
+  build on Read the Docs.
+
+## Design Guidelines
+
+- Keep API calls behind `GlpiClient` methods.
+- Prefer field-validated Pydantic models for request and response payloads.
+- Avoid organization-specific category, entity, or profile defaults in the
+  library core.
+- Add tests for payload serialization and response normalization when adding
+  endpoints.

glpi_python_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 glpi-python-client contributors
+
+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.

glpi_python_client-0.1.0/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: glpi-python-client
+Version: 0.1.0
+Summary: A typed Python client for GLPI ITSM APIs.
+Project-URL: Homepage, https://github.com/baraline/glpi_python_client
+Project-URL: Documentation, https://glpi-python-client.readthedocs.io/en/latest/
+Project-URL: Issues, https://github.com/baraline/glpi_python_client/issues
+Project-URL: Source, https://github.com/baraline/glpi_python_client
+Author: glpi-python-client contributors
+License: MIT
+License-File: LICENSE
+Keywords: api,client,glpi,itsm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4>=4.12
+Requires-Dist: lxml>=4.9
+Requires-Dist: markdown>=3.6
+Requires-Dist: markdownify>=0.13
+Requires-Dist: pydantic>=2.8
+Requires-Dist: requests>=2.31
+Requires-Dist: tenacity>=8.2
+Requires-Dist: urllib3>=2.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: numpydoc>=1.8; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'dev'
+Requires-Dist: sphinx<8.2,>=7.2; extra == 'dev'
+Requires-Dist: tomli>=2.0; (python_version < '3.11') and extra == 'dev'
+Requires-Dist: twine>=5.1; extra == 'dev'
+Requires-Dist: types-requests>=2.32; extra == 'dev'
+Requires-Dist: vulture>=2.11; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: numpydoc>=1.8; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'docs'
+Requires-Dist: sphinx<8.2,>=7.2; extra == 'docs'
+Requires-Dist: tomli>=2.0; (python_version < '3.11') and extra == 'docs'
+Description-Content-Type: text/markdown
+
+# glpi-python-client
+
+[![CI](https://github.com/baraline/glpi_python_client/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/baraline/glpi_python_client/actions/workflows/ci.yml)
+[![License](https://img.shields.io/github/license/baraline/glpi_python_client)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://github.com/baraline/glpi_python_client)
+[![Docs](https://readthedocs.org/projects/glpi-python-client/badge/?version=latest)](https://glpi-python-client.readthedocs.io/en/latest/)
+
+`glpi-python-client` is a typed Python client for GLPI ITSM APIs.
+
+The goal is to let GLPI integrations work with domain objects instead of raw
+JSON payloads. The package exposes Pydantic models for tickets, users,
+followups, documents, locations, and related records, while converting GLPI
+HTML content into Markdown for Python-side workflows and rendering Markdown
+back to HTML for outgoing payloads.
+
+It currently focuses on ticket-centric workflows and exposes matching sync and
+async high-level clients.
+
+## Installation
+
+```bash
+pip install glpi-python-client
+```
+
+For local development:
+
+```bash
+python -m pip install -e .[dev]
+python -m pytest
+```
+
+## Quick Start
+
+Create a client with your GLPI API URL and at least one complete auth pair:
+
+- `client_id` and `client_secret`
+- `username` and `password`
+- both pairs together
+
+```python
+from glpi_python_client import GlpiClient, GlpiTicket
+
+with GlpiClient(
+    glpi_api_url="https://glpi.example.com/api.php",
+    client_id="oauth-client-id",
+    client_secret="oauth-client-secret",
+    username="api-user",
+    password="api-password",
+) as glpi:
+    ticket_id = glpi.create_ticket(
+        GlpiTicket(
+            name="Printer issue",
+            content="The printer is not reachable from the office network.",
+            urgency=3,
+            impact=3,
+        )
+    )
+    ticket = glpi.get_ticket_record(ticket_id)
+
+    print(ticket.id)
+    print(ticket.content)
+```
+
+Async code uses the same model layer and nearly the same API surface:
+
+```python
+from glpi_python_client import AsyncGlpiClient
+
+async with AsyncGlpiClient(
+    glpi_api_url="https://glpi.example.com/api.php",
+    client_id="oauth-client-id",
+    client_secret="oauth-client-secret",
+) as glpi:
+    tickets = await glpi.search_ticket_records(query='status.id=in=(1,2)')
+```
+
+If your application already provides `GLPI_` environment variables,
+`GlpiClient.from_env()` and `AsyncGlpiClient.from_env()` are also available.
+
+## Documentation
+
+- [Hosted documentation](https://glpi-python-client.readthedocs.io/en/latest/)
+- [API reference](https://glpi-python-client.readthedocs.io/en/latest/api_reference.html)
+- [Installation guide](https://glpi-python-client.readthedocs.io/en/latest/installation.html)
+- [Development guide](https://glpi-python-client.readthedocs.io/en/latest/development_rtd.html)
+
+To build the Sphinx documentation locally:
+
+```bash
+python -m pip install -e .[docs]
+python -m sphinx -b html docs docs/_build/html
+```

glpi_python_client-0.1.0/README.md

@@ -0,0 +1,92 @@
+# glpi-python-client
+
+[![CI](https://github.com/baraline/glpi_python_client/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/baraline/glpi_python_client/actions/workflows/ci.yml)
+[![License](https://img.shields.io/github/license/baraline/glpi_python_client)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://github.com/baraline/glpi_python_client)
+[![Docs](https://readthedocs.org/projects/glpi-python-client/badge/?version=latest)](https://glpi-python-client.readthedocs.io/en/latest/)
+
+`glpi-python-client` is a typed Python client for GLPI ITSM APIs.
+
+The goal is to let GLPI integrations work with domain objects instead of raw
+JSON payloads. The package exposes Pydantic models for tickets, users,
+followups, documents, locations, and related records, while converting GLPI
+HTML content into Markdown for Python-side workflows and rendering Markdown
+back to HTML for outgoing payloads.
+
+It currently focuses on ticket-centric workflows and exposes matching sync and
+async high-level clients.
+
+## Installation
+
+```bash
+pip install glpi-python-client
+```
+
+For local development:
+
+```bash
+python -m pip install -e .[dev]
+python -m pytest
+```
+
+## Quick Start
+
+Create a client with your GLPI API URL and at least one complete auth pair:
+
+- `client_id` and `client_secret`
+- `username` and `password`
+- both pairs together
+
+```python
+from glpi_python_client import GlpiClient, GlpiTicket
+
+with GlpiClient(
+    glpi_api_url="https://glpi.example.com/api.php",
+    client_id="oauth-client-id",
+    client_secret="oauth-client-secret",
+    username="api-user",
+    password="api-password",
+) as glpi:
+    ticket_id = glpi.create_ticket(
+        GlpiTicket(
+            name="Printer issue",
+            content="The printer is not reachable from the office network.",
+            urgency=3,
+            impact=3,
+        )
+    )
+    ticket = glpi.get_ticket_record(ticket_id)
+
+    print(ticket.id)
+    print(ticket.content)
+```
+
+Async code uses the same model layer and nearly the same API surface:
+
+```python
+from glpi_python_client import AsyncGlpiClient
+
+async with AsyncGlpiClient(
+    glpi_api_url="https://glpi.example.com/api.php",
+    client_id="oauth-client-id",
+    client_secret="oauth-client-secret",
+) as glpi:
+    tickets = await glpi.search_ticket_records(query='status.id=in=(1,2)')
+```
+
+If your application already provides `GLPI_` environment variables,
+`GlpiClient.from_env()` and `AsyncGlpiClient.from_env()` are also available.
+
+## Documentation
+
+- [Hosted documentation](https://glpi-python-client.readthedocs.io/en/latest/)
+- [API reference](https://glpi-python-client.readthedocs.io/en/latest/api_reference.html)
+- [Installation guide](https://glpi-python-client.readthedocs.io/en/latest/installation.html)
+- [Development guide](https://glpi-python-client.readthedocs.io/en/latest/development_rtd.html)
+
+To build the Sphinx documentation locally:
+
+```bash
+python -m pip install -e .[docs]
+python -m sphinx -b html docs docs/_build/html
+```

glpi_python_client-0.1.0/docs/api_reference.rst

@@ -0,0 +1,76 @@
+API Reference
+=============
+
+This reference documents the public package surface exported by ``glpi_python_client``.
+Internal implementation modules and underscore-prefixed helpers are
+intentionally omitted.
+
+.. currentmodule:: glpi_python_client
+
+Client
+------
+
+.. autoclass:: GlpiClient
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+.. autoclass:: AsyncGlpiClient
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+Legacy v1 Session
+-----------------
+
+.. autoclass:: GLPIV1Session
+   :members:
+   :show-inheritance:
+
+Models
+------
+
+.. autoclass:: GlpiUser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiLocation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiTicket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiFollowup
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiTask
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiSolution
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiDocument
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiTeamMember
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Package Metadata
+----------------
+
+.. autodata:: __version__

glpi_python_client-0.1.0/docs/conf.py

@@ -0,0 +1,66 @@
+"""Sphinx configuration for the glpi-python-client documentation."""
+
+from __future__ import annotations
+
+from datetime import date
+from importlib.metadata import PackageNotFoundError, version
+from pathlib import Path
+
+try:
+    from tomllib import loads as toml_loads
+except ModuleNotFoundError:
+    from tomli import loads as toml_loads
+
+
+def _read_project_version() -> str:
+    pyproject_path = Path(__file__).resolve().parents[1] / "pyproject.toml"
+    pyproject_data = toml_loads(pyproject_path.read_text(encoding="utf-8"))
+    return str(pyproject_data["project"]["version"])
+
+
+project = "glpi-python-client"
+author = "glpi-python-client contributors"
+copyright = f"{date.today().year}, {author}"
+
+try:
+    release = version("glpi-python-client")
+except PackageNotFoundError:
+    release = _read_project_version()
+
+version = release
+
+extensions = [
+    "numpydoc",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+html_title = "glpi-python-client documentation"
+
+add_module_names = False
+autoclass_content = "both"
+autodoc_class_signature = "mixed"
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
+    "special-members": "__enter__, __exit__",
+}
+autodoc_typehints = "description"
+autosummary_generate = True
+
+numpydoc_class_members_toctree = False
+numpydoc_show_class_members = True
+numpydoc_xref_param_type = True
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "requests": ("https://requests.readthedocs.io/en/latest/", None),
+}

glpi_python_client-0.1.0/docs/development.md

@@ -0,0 +1,90 @@
+# Development Guide
+
+## Local Setup
+
+Create a virtual environment and install the package with development dependencies:
+
+```bash
+python -m venv .venv
+.venv\Scripts\activate
+python -m pip install --upgrade pip
+python -m pip install -e .[dev]
+```
+
+## Checks
+
+Run these before publishing or opening a pull request:
+
+```bash
+python -m pytest
+python -m ruff check .
+python -m mypy glpi_python_client
+python -m sphinx -b html docs docs/_build/html
+python -m build
+python -m vulture glpi_python_client --min-confidence 80
+```
+
+If your global Python environment has broken pytest plugins, run the suite with
+plugin autoload disabled:
+
+```bash
+$env:PYTEST_DISABLE_PLUGIN_AUTOLOAD = "1"
+python -m pytest
+```
+
+## Package Layout
+
+- `glpi_python_client.__init__` exposes the public import surface.
+- `glpi_python_client.clients.api_v2_client.GlpiClient` owns synchronous API
+  configuration, authentication, context-manager cleanup, and the small
+  user/location/document provisioning surface.
+- `glpi_python_client.clients.async_api_v2_client.AsyncGlpiClient` owns the
+  matching awaitable client surface and keeps blocking requests behind
+  `asyncio.to_thread()` boundaries.
+- `glpi_python_client.clients.v2` contains the internal v2 implementation
+  packages.
+- `glpi_python_client.clients.v2.common` holds reusable setup, endpoint,
+  request, pagination, payload, filter, and error helpers shared by both
+  execution models.
+- `glpi_python_client.clients.v2.sync` contains the synchronous endpoint mixins:
+  `transport`, `tickets`, `timeline`, `documents`, `team`, and `directory`.
+  `sync.api` assembles those mixins.
+- `glpi_python_client.clients.v2.async_` contains the matching asynchronous
+  endpoint mixins and keeps `asyncio.to_thread()` at the blocking request and
+  v1-session boundaries. `async_.api` assembles those mixins.
+- `glpi_python_client.clients._shared` is a compatibility module that re-exports
+  the scoped v2 helper modules for older internal imports.
+- `glpi_python_client.clients.api_v1_session` contains the legacy v1 session
+  used for document operations.
+- `glpi_python_client.models` contains typed request and response models.
+- `glpi_python_client.content.records` is a compatibility package for raw GLPI
+  payload conversion.
+- `glpi_python_client.content.records.core` contains shared normalization,
+  scalar coercion, nested-reference parsing, and timeline document-link
+  helpers.
+- `glpi_python_client.content.records.parsers` contains model-specific parsers
+  for tickets, timeline items, documents, team members, users, and locations.
+- `docs` contains the Read the Docs/Sphinx documentation source.
+- `skills` contains contributor-facing Agent Skills for repository workflows.
+  The source distribution includes them for source consumers and contributors,
+  but the wheel still installs only the `glpi_python_client` runtime package.
+
+## Adding Endpoints
+
+1. Add or extend a model in `glpi_python_client.models`.
+2. Add response parsing in the matching
+  `glpi_python_client.content.records.parsers` module when the endpoint returns
+  structured data, and put shared parsing helpers in
+  `glpi_python_client.content.records.core` only when multiple parsers need
+  them.
+3. Add the client method in the matching
+  `glpi_python_client.clients.v2.sync` module and the matching
+  `glpi_python_client.clients.v2.async_` module when applicable.
+4. Put reusable endpoint names, payload builders, response handling, or
+  pagination logic in the focused `glpi_python_client.clients.v2.common`
+  helper module named for that responsibility.
+5. Add tests for payload serialization, response parsing, and client behavior.
+6. Document the new workflow in `docs/usage.md` or the README.
+
+Keep organization-specific defaults outside the package core. Applications can
+map their own entities, profiles, and categories before calling the client.

glpi_python_client-0.1.0/docs/development_rtd.rst

@@ -0,0 +1,61 @@
+Development
+===========
+
+Local Setup
+-----------
+
+Create a virtual environment and install the development dependencies:
+
+.. code-block:: console
+
+   python -m venv .venv
+   .venv\Scripts\activate
+   python -m pip install --upgrade pip
+   python -m pip install -e .[dev]
+
+Quality Checks
+--------------
+
+Run the focused checks before opening a pull request:
+
+.. code-block:: console
+
+   python -m pytest
+   python -m ruff check .
+   python -m mypy glpi_python_client
+   python -m sphinx -b html docs docs/_build/html
+
+Package Layout
+--------------
+
+``glpi_python_client.__init__``
+   Public import surface.
+
+``glpi_python_client._client_v2``
+   Main ``GlpiClient`` implementation, configuration, authentication, and
+   context-manager cleanup.
+
+``glpi_python_client._api``
+   High-level GLPI endpoint helpers.
+
+``glpi_python_client._client_v1``
+   Legacy v1 session used for document operations.
+
+``glpi_python_client.models``
+   Typed request and response models.
+
+``glpi_python_client._records``
+   Raw GLPI payload normalization and model conversion.
+
+Adding Endpoints
+----------------
+
+#. Add or extend a model in ``glpi_python_client.models``.
+#. Add response parsing in ``glpi_python_client._records`` when needed.
+#. Add the client method in ``glpi_python_client._api``.
+#. Add tests for payload serialization, response parsing, and client behavior.
+#. Document the workflow in :doc:`user_guide` or the README.
+
+Keep organization-specific entity, profile, and category defaults outside the
+library core. Applications can apply their own mapping before calling the
+client.

glpi_python_client-0.1.0/docs/index.rst

@@ -0,0 +1,33 @@
+glpi-python-client Documentation
+================================
+
+``glpi-python-client`` is a typed Python package for interacting with GLPI ITSM APIs.
+It provides a reusable ``GlpiClient`` object, typed models, OAuth2 token
+handling, and helpers for ticket, user, location, and document workflows.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: User Guide
+
+   installation
+   user_guide
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API Documentation
+
+   api_reference
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Project
+
+   development_rtd
+   publishing_rtd
+
+Indices and Tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`