glpi-python-client 0.1.3__tar.gz → 0.2.0__tar.gz

glpi_python_client-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.13
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format

{glpi_python_client-0.1.3 → glpi_python_client-0.2.0}/CONTRIBUTING.md

@@ -8,14 +8,21 @@ Thank you for improving `glpi-python-client`.
 python -m venv .venv
 .venv\Scripts\activate
 python -m pip install -e .[dev]
+python -m pre_commit install
+python -m pre_commit run --all-files
 python -m pytest
 ```
 
+The repository ships a root `.pre-commit-config.yaml` that runs Ruff on each
+commit. The lint hook applies safe fixes first, then Ruff formats the touched
+files.
+
 ## Quality Checks
 
 Run the focused checks before opening a pull request:
 
 ```bash
+python -m pre_commit run --all-files
 python -m pytest
 python -m ruff check .
 python -m mypy glpi_python_client
@@ -26,7 +33,7 @@ python -m mypy glpi_python_client
 To build the documentation locally:
 
 ```bash
-python -m sphinx -W --keep-going -b html docs docs/_build/html pa
+python -m sphinx -W --keep-going -b html docs docs/_build/html
 ```
 
 ## GitHub Actions

{glpi_python_client-0.1.3 → glpi_python_client-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glpi-python-client
-Version: 0.1.3
+Version: 0.2.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/
@@ -30,11 +30,15 @@ Requires-Dist: markdownify>=0.13
 Requires-Dist: pydantic>=2.8
 Requires-Dist: requests>=2.31
 Requires-Dist: tenacity>=8.2
+Requires-Dist: typing-extensions>=4.7; python_version < '3.11'
 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: pre-commit>=4.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; 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'
@@ -53,6 +57,7 @@ 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)
+[![Coverage](https://codecov.io/gh/baraline/glpi_python_client/branch/main/graph/badge.svg)](https://codecov.io/gh/baraline/glpi_python_client)
 [![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/)
@@ -65,8 +70,10 @@ 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.
+It currently focuses on ticket-centric workflows and exposes a single
+asynchronous high-level client built on top of the GLPI v2 REST API.
+
+While the package is preparing for 1.0, alot of potential breaking change might happen between versions. A deprecation policy will be put in place once 1.0 is out and the package have been stabilized.
 
 ## Installation
 
@@ -83,51 +90,71 @@ python -m pytest
 
 ## Quick Start
 
-Create a client with your GLPI API URL and at least one complete auth pair:
+Create a client with your GLPI v2 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,
+import asyncio
+
+from glpi_python_client import GlpiClient, PostTicket
+
+
+async def main() -> None:
+    async with GlpiClient(
+        glpi_api_url="https://glpi.example.com/api.php/v2",
+        client_id="oauth-client-id",
+        client_secret="oauth-client-secret",
+        username="api-user",
+        password="api-password",
+    ) as glpi:
+        ticket_id = await glpi.create_ticket(
+            PostTicket(
+                name="Printer issue",
+                content="The printer is not reachable from the office network.",
+            )
         )
-    )
-    ticket = glpi.get_ticket_record(ticket_id)
+        ticket = await glpi.get_ticket(ticket_id)
+        print(ticket.id, ticket.name)
+
 
-    print(ticket.id)
-    print(ticket.content)
+asyncio.run(main())
 ```
 
-Async code uses the same model layer and nearly the same API surface:
+If your application already provides `GLPI_` environment variables,
+`GlpiClient.from_env()` is also available.
+
+### Calling from synchronous code
+
+The client is async-only, but it works from sync programs through
+`asyncio.run`. Wrap the calls in a coroutine and execute it once:
 
 ```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)')
+import asyncio
+
+from glpi_python_client import GlpiClient
+
+
+def fetch_open_tickets() -> list[int]:
+    async def _run() -> list[int]:
+        async with GlpiClient.from_env() as glpi:
+            tickets = await glpi.search_tickets("status==1", limit=10)
+            return [ticket.id for ticket in tickets]
+
+    return asyncio.run(_run())
+
+
+if __name__ == "__main__":
+    print(fetch_open_tickets())
 ```
 
-If your application already provides `GLPI_` environment variables,
-`GlpiClient.from_env()` and `AsyncGlpiClient.from_env()` are also available.
+For long-lived sync services that need many calls, run a dedicated
+event loop on a background thread and dispatch with
+`asyncio.run_coroutine_threadsafe`. See the
+[user guide](https://glpi-python-client.readthedocs.io/en/latest/user_guide.html#calling-the-client-from-synchronous-code)
+for the full pattern.
 
 ## Documentation
 

glpi_python_client-0.2.0/README.md

@@ -0,0 +1,115 @@
+# 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)
+[![Coverage](https://codecov.io/gh/baraline/glpi_python_client/branch/main/graph/badge.svg)](https://codecov.io/gh/baraline/glpi_python_client)
+[![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 a single
+asynchronous high-level client built on top of the GLPI v2 REST API.
+
+While the package is preparing for 1.0, alot of potential breaking change might happen between versions. A deprecation policy will be put in place once 1.0 is out and the package have been stabilized.
+
+## 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 v2 API URL and at least one complete auth pair:
+
+- `client_id` and `client_secret`
+- `username` and `password`
+- both pairs together
+
+```python
+import asyncio
+
+from glpi_python_client import GlpiClient, PostTicket
+
+
+async def main() -> None:
+    async with GlpiClient(
+        glpi_api_url="https://glpi.example.com/api.php/v2",
+        client_id="oauth-client-id",
+        client_secret="oauth-client-secret",
+        username="api-user",
+        password="api-password",
+    ) as glpi:
+        ticket_id = await glpi.create_ticket(
+            PostTicket(
+                name="Printer issue",
+                content="The printer is not reachable from the office network.",
+            )
+        )
+        ticket = await glpi.get_ticket(ticket_id)
+        print(ticket.id, ticket.name)
+
+
+asyncio.run(main())
+```
+
+If your application already provides `GLPI_` environment variables,
+`GlpiClient.from_env()` is also available.
+
+### Calling from synchronous code
+
+The client is async-only, but it works from sync programs through
+`asyncio.run`. Wrap the calls in a coroutine and execute it once:
+
+```python
+import asyncio
+
+from glpi_python_client import GlpiClient
+
+
+def fetch_open_tickets() -> list[int]:
+    async def _run() -> list[int]:
+        async with GlpiClient.from_env() as glpi:
+            tickets = await glpi.search_tickets("status==1", limit=10)
+            return [ticket.id for ticket in tickets]
+
+    return asyncio.run(_run())
+
+
+if __name__ == "__main__":
+    print(fetch_open_tickets())
+```
+
+For long-lived sync services that need many calls, run a dedicated
+event loop on a background thread and dispatch with
+`asyncio.run_coroutine_threadsafe`. See the
+[user guide](https://glpi-python-client.readthedocs.io/en/latest/user_guide.html#calling-the-client-from-synchronous-code)
+for the full pattern.
+
+## 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.2.0/docs/api_reference.rst

@@ -0,0 +1,325 @@
+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:
+
+Aggregated Models
+-----------------
+
+.. autoclass:: GlpiTicketContext
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Common Reference Models
+-----------------------
+
+.. autoclass:: IdRef
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: IdNameRef
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: IdNameCompletenameRef
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Tickets
+-------
+
+.. autoclass:: GetTicket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PostTicket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PatchTicket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: DeleteTicket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Ticket Timeline — Followups
+---------------------------
+
+.. autoclass:: GetFollowup
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PostFollowup
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PatchFollowup
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: DeleteFollowup
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Ticket Timeline — Tasks
+-----------------------
+
+.. autoclass:: GetTicketTask
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PostTicketTask
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PatchTicketTask
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: DeleteTicketTask
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Ticket Timeline — Solutions
+---------------------------
+
+.. autoclass:: GetSolution
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PostSolution
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PatchSolution
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: DeleteSolution
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Ticket Timeline — Documents
+---------------------------
+
+.. autoclass:: GetTimelineDocument
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PostTimelineDocument
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PatchTimelineDocument
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: DeleteTimelineDocument
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Ticket Team Members
+-------------------
+
+.. autoclass:: GetTeamMember
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PostTeamMember
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PatchTeamMember
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: DeleteTeamMember
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Documents
+---------
+
+.. autoclass:: GetDocument
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PostDocument
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PatchDocument
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: DeleteDocument
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Users
+-----
+
+.. autoclass:: GetUser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PostUser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PatchUser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: DeleteUser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Locations
+---------
+
+.. autoclass:: GetLocation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PostLocation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PatchLocation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: DeleteLocation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Entities
+--------
+
+.. autoclass:: GetEntity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PostEntity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: PatchEntity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: DeleteEntity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Enums
+-----
+
+.. autoclass:: GlpiEnum
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiTicketStatus
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiTicketType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiPriority
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiTaskState
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiSolutionStatus
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiTimelinePosition
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiUserAuthType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: GlpiGlobalValidation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Package Metadata
+----------------
+
+.. autodata:: __version__

{glpi_python_client-0.1.3 → glpi_python_client-0.2.0}/docs/development.md

@@ -9,13 +9,19 @@ python -m venv .venv
 .venv\Scripts\activate
 python -m pip install --upgrade pip
 python -m pip install -e .[dev]
+python -m pre_commit install
 ```
 
+The repository ships a root `.pre-commit-config.yaml` that runs Ruff on each
+commit. The lint hook applies safe fixes first, then Ruff formats the touched
+files.
+
 ## Checks
 
 Run these before publishing or opening a pull request:
 
 ```bash
+python -m pre_commit run --all-files
 python -m pytest
 python -m ruff check .
 python -m mypy glpi_python_client