python-rundeck 1.0.1__tar.gz → 2.0.0__tar.gz

{python_rundeck-1.0.1 → python_rundeck-2.0.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: python-rundeck
-Version: 1.0.1
-Summary: Python client for the Rundeck API (v14-v56).
+Version: 2.0.0
+Summary: Python client for the Rundeck Community API (v14-v59).
 License-Expression: MIT
 License-File: LICENSE
 Keywords: rundeck,api,client
@@ -43,7 +43,9 @@ python-rundeck
 ![License](https://img.shields.io/pypi/l/python-rundeck)
 ![Downloads](https://static.pepy.tech/badge/python-rundeck)
 
-Python client for the Rundeck API (v14-v56), inspired by the python-gitlab architecture. Provides typed managers for key resources (projects, jobs, executions, tokens, users, system, configuration) and SCM (import/export).
+Python client for the Rundeck Community API (v14-v59), inspired by the python-gitlab architecture. The default API version is v59; current Rundeck servers require v17 or later and versions below v34 are deprecated. Provides typed managers for Community resources (projects, jobs, executions, tokens, users, system) and SCM (import/export).
+
+Version 2.0 removes commercial-only Config Management and job-tag endpoints. Cluster schedule listing and takeover are Community operations and remain available. The authorization-evaluation endpoints are experimental in Rundeck and are exposed as such by this client.
 
 Contents
 --------
@@ -69,9 +71,9 @@ Quick start
 ```python
 from rundeck.client import Rundeck
 
-rd = Rundeck(url="https://rundeck.example.com", token="MY_TOKEN", api_version=56)
+rd = Rundeck(url="https://rundeck.example.com", token="MY_TOKEN")
 # Password auth (session cookie) if no token
-rd = Rundeck(url="https://rundeck.example.com", username="admin", password="admin", api_version=56)
+rd = Rundeck(url="https://rundeck.example.com", username="admin", password="admin")
 
 # List projects
 projects = rd.projects.list()
@@ -94,20 +96,24 @@ Main parameters:
 - `url`: Rundeck URL (e.g. `https://rundeck.example.com`)
 - `token`: API token (header `X-Rundeck-Auth-Token`)
 - `username` / `password`: Session authentication (j_security_check) if no token is provided.
-- `api_version`: API version (e.g. `56`)
+- `api_version`: API version (default: `59`; older versions can be selected explicitly)
 - `timeout`: Request timeout (float, seconds)
 - `ssl_verify`: TLS verification (bool or CA path)
+- `user_agent`: Custom HTTP User-Agent (string)
+- `config_section`: Section name in config files (default: `rundeck`)
 
 Config files: if needed, pass `config_files` or `Rundeck.from_config(config_section=...)`.
 Useful env vars (client config):
 - `RUNDECK_URL`: Base URL
 - `RUNDECK_TOKEN`: API token (header `X-Rundeck-Auth-Token`)
 - `RUNDECK_USERNAME` / `RUNDECK_PASSWORD`: Session auth (if no token)
-- `RUNDECK_API_VERSION`: API version (e.g. 56)
+- `RUNDECK_API_VERSION`: API version (default `59`; older server versions can be selected explicitly)
 - `RUNDECK_TIMEOUT`: Request timeout (seconds)
 - `RUNDECK_SSL_VERIFY`: TLS verification (bool or CA path)
 - `RUNDECK_USER_AGENT`: HTTP User-Agent
 
+Rundeck 6.0+ accepts JSON for REST requests and responses. XML/YAML remain supported only as job, archive, and resource document formats.
+
 Available resources
 -------------------
 - `projects` (`ProjectManager`): CRUD projects, job export/import, project config, archive (export/import).
@@ -115,13 +121,15 @@ Available resources
 - `executions` (`ExecutionManager`): list/filter, running, get/delete, advanced query.
 - `tokens` (`TokenManager`): list, get, create, delete.
 - `users` (`UserManager`): user operations (per current implementation).
-- `metrics` (`MetricsManager`): `/metrics` endpoints (list/data/healthcheck/ping).
+- `metrics` (`MetricsManager`): legacy `/api/V/metrics` endpoints (list/data/healthcheck/ping/threads).
+- `monitoring` (`MonitoringManager`): modern non-versioned `/monitoring/*` endpoints (Prometheus, metrics, health, readiness, info, thread dump).
+- `authorizations` (`AuthorizationsManager`): experimental authorization evaluation endpoints.
 - `plugins` (`PluginManager`): list installed plugins (`/plugin/list`).
 - `webhooks` (`WebhookEventManager` + `ProjectWebhookManager`): project webhook management and sending via token.
 - `key_storage` (`StorageKeyManager`): key storage management `/storage/keys`.
 - `adhoc` (`AdhocManager`, via `project.adhoc`): run AdHoc commands/scripts.
-- `system` (`SystemManager`): system info, executions enable/disable, logstorage, ACL.
-- `config_management` (`ConfigManagementManager`): global configuration `/config`.
+- `system` (`SystemManager`): system info and summary, executions enable/disable, logstorage, ACL.
+- `scheduler` (`SchedulerManager`): scheduled job listing and cluster schedule takeover (Community).
 - `scm` (via `project.scm` and `job.scm`): import/export plugins, setup, enable/disable, status, actions (commit/import/export...).
 
 Return types policy
@@ -130,7 +138,7 @@ Return types policy
 - Factory managers return the created resource object for actions that create it
   (e.g., `project.adhoc` returns `Execution`).
 - Utility managers return raw API responses (dict/str/bytes).
-- `delete(...)` returns `None`.
+- CRUD `delete(...)` returns `None`; action endpoints returning a result body return that raw result.
 - Object methods return raw API responses and update the object in place when needed.
 - Explicit flags are used when an object return is requested (e.g., `as_execution=True`).
 
@@ -142,7 +150,7 @@ Factory managers:
   Returns `Execution` objects (execution factory).
 
 Utility managers:
-- `system`, `config_management`, `metrics`, `scheduler`, `webhooks` (event send).
+- `system`, `metrics`, `scheduler`, `webhooks` (event send), `authorizations` (experimental).
 - `scm` (via `project.scm` and `job.scm`), and project sub-managers like
   `project.config`, `project.resources`, `project.sources`, `project.readme`,
   `project.archive`, `project.acl`.
@@ -150,6 +158,13 @@ Utility managers:
 Note: `project.webhooks.create(...)` returns the raw API response (e.g., `{"msg": "Saved webhook"}`)
 because the Rundeck API does not return the created webhook object.
 
+Migration from 1.1.0
+-------------------
+- Set `api_version=59` explicitly when upgrading a server/client pair gradually; the default is now 59.
+- Remove calls to `rd.config_management` and `job.tags()`: their endpoints are only available in commercial Rundeck products.
+- `rd.scheduler.takeover()` and scheduler job listing remain supported by Community. On a non-cluster server, takeover returns a successful response indicating that no action was performed.
+- `rd.authorizations` wraps experimental endpoints and can change with Rundeck releases.
+
 Example:
 ```python
 job = rd.jobs.get("job-id")          # -> Job (object)
@@ -257,9 +272,11 @@ job.enable_schedule()
 job.disable_schedule()
 info = job.info()
 meta = job.meta(meta="name,description")
-tags = job.tags()
+meta = job.meta(meta="*", meta_exclude="stats")  # API v58+
 workflow = job.workflow()
-forecast = job.forecast(time="2024-05-01T10:00:00Z", max=5)
+forecast = job.forecast(time="2024-05-01T10:00:00Z", max=5, past=False)
+executions = job.executions(include_job_ref=True)
+deleted = job.delete_executions()
 
 # Export/import jobs via manager (project parameter or parent)
 rd.jobs.export(project="demo", format="xml", idlist="id1,id2", groupPath="group")
@@ -460,14 +477,35 @@ if features:
     print(first.name, status.enabled)
 ```
 
-Global configuration `/config`
+Monitoring
+----------
+```python
+# Rundeck 6.0+ modern endpoints, outside /api/V.
+health = rd.monitoring.health()
+prometheus_text = rd.monitoring.prometheus()
+metric = rd.monitoring.metric("jvm.memory.used", tags=["area:heap"])
+thread_dump = rd.monitoring.thread_dump()
+
+# Legacy metrics require rundeck.metrics.legacy.enabled=true on Rundeck 6.0.
+legacy_threads = rd.metrics.threads()
+ready = rd.monitoring.readiness()
+```
+
+Community additions
+-------------------
 ```python
-cfg = rd.config_management
-all_configs = cfg.list()
-cfg.save([{"key": "ui.banner", "value": "Hello"}])
-cfg.delete("ui.banner", strata="default")
-cfg.refresh()
-cfg.restart()
+api_info = rd.api_info()
+summary = rd.system.summary()
+scheduled_jobs = rd.scheduler.jobs()
+rd.tokens.remove_expired("admin")  # use "*" with suitable administrator rights
+
+project = rd.projects.get("demo")
+project.plugins.save("ResourceModelSource", "resources.source", plugins=[])
+project.archive.export_async(execution_ids=["1", "2"], use_post=True)
+project.jobs.validate_option(option_data, job_was_scheduled=False)
+
+# Experimental authorization API; actions are repeated query parameters.
+permissions = rd.authorizations.application_kind("job", ["read", "run"])
 ```
 
 Pagination
@@ -488,12 +526,13 @@ Development and testing
 - Formatting/Lint: `black src/rundeck tests/`, `ruff check src/rundeck tests/`
 - Typing: `mypy src/rundeck/`
 - Tests: `pytest`
-- Local integration tests: `scripts/run-integration.sh` (starts docker compose at repo root, exports by default `RUNDECK_URL=http://localhost:4440`, `RUNDECK_TOKEN=adminToken`, `RUNDECK_API_VERSION=56`, waits for the healthcheck, runs `poetry run pytest -m integration`). You can override env vars before running. Add `KEEP_STACK=1` to keep the instance running after tests. Dedicated teardown script: `scripts/stop-integration.sh`.
+- Local integration tests: `scripts/run-integration.sh` starts Rundeck Community 6.2.1 by default with API v59. Use `RUNDECK_IMAGE=rundeck/rundeck:6.0.1 RUNDECK_API_VERSION=58` or `RUNDECK_IMAGE=rundeck/rundeck:5.18.0 RUNDECK_API_VERSION=56` for compatibility runs. Add `KEEP_STACK=1` to keep the instance running after tests. Dedicated teardown script: `scripts/stop-integration.sh`.
+- The docker compose stack mounts `tokens.properties` at the repo root to seed a local admin token for integration tests. This file is only intended for local testing.
 
 Code structure
 --------------
 - `src/rundeck/base.py`: generic objects/managers, `_build_path` helpers, pagination, CRUD.
 - `src/rundeck/client.py`: HTTP client, `http_get/post/put/delete/list` methods.
-- `src/rundeck/v1/objects/`: domain managers and objects (projects, jobs, executions, system, tokens, users, config_management).
-- Managers/objects schema: we apply the manager -> object pattern wherever the API exposes an identifiable resource (jobs, projects, users, tokens, executions, etc.). For purely global or utility endpoints without a resource (e.g., `/system` and its subdomains, `/config`, `/metrics`), we use dedicated sub-managers rather than forcing an artificial object.
+- `src/rundeck/v1/objects/`: Community domain managers and objects (projects, jobs, executions, system, tokens, users, authorizations).
+- Managers/objects schema: we apply the manager -> object pattern wherever the API exposes an identifiable resource (jobs, projects, users, tokens, executions, etc.). For global or utility endpoints without a resource (e.g., `/system`, `/scheduler`, `/metrics`), we use dedicated sub-managers rather than forcing an artificial object.
 

{python_rundeck-1.0.1 → python_rundeck-2.0.0}/README.md

@@ -5,7 +5,9 @@ python-rundeck
 ![License](https://img.shields.io/pypi/l/python-rundeck)
 ![Downloads](https://static.pepy.tech/badge/python-rundeck)
 
-Python client for the Rundeck API (v14-v56), inspired by the python-gitlab architecture. Provides typed managers for key resources (projects, jobs, executions, tokens, users, system, configuration) and SCM (import/export).
+Python client for the Rundeck Community API (v14-v59), inspired by the python-gitlab architecture. The default API version is v59; current Rundeck servers require v17 or later and versions below v34 are deprecated. Provides typed managers for Community resources (projects, jobs, executions, tokens, users, system) and SCM (import/export).
+
+Version 2.0 removes commercial-only Config Management and job-tag endpoints. Cluster schedule listing and takeover are Community operations and remain available. The authorization-evaluation endpoints are experimental in Rundeck and are exposed as such by this client.
 
 Contents
 --------
@@ -31,9 +33,9 @@ Quick start
 ```python
 from rundeck.client import Rundeck
 
-rd = Rundeck(url="https://rundeck.example.com", token="MY_TOKEN", api_version=56)
+rd = Rundeck(url="https://rundeck.example.com", token="MY_TOKEN")
 # Password auth (session cookie) if no token
-rd = Rundeck(url="https://rundeck.example.com", username="admin", password="admin", api_version=56)
+rd = Rundeck(url="https://rundeck.example.com", username="admin", password="admin")
 
 # List projects
 projects = rd.projects.list()
@@ -56,20 +58,24 @@ Main parameters:
 - `url`: Rundeck URL (e.g. `https://rundeck.example.com`)
 - `token`: API token (header `X-Rundeck-Auth-Token`)
 - `username` / `password`: Session authentication (j_security_check) if no token is provided.
-- `api_version`: API version (e.g. `56`)
+- `api_version`: API version (default: `59`; older versions can be selected explicitly)
 - `timeout`: Request timeout (float, seconds)
 - `ssl_verify`: TLS verification (bool or CA path)
+- `user_agent`: Custom HTTP User-Agent (string)
+- `config_section`: Section name in config files (default: `rundeck`)
 
 Config files: if needed, pass `config_files` or `Rundeck.from_config(config_section=...)`.
 Useful env vars (client config):
 - `RUNDECK_URL`: Base URL
 - `RUNDECK_TOKEN`: API token (header `X-Rundeck-Auth-Token`)
 - `RUNDECK_USERNAME` / `RUNDECK_PASSWORD`: Session auth (if no token)
-- `RUNDECK_API_VERSION`: API version (e.g. 56)
+- `RUNDECK_API_VERSION`: API version (default `59`; older server versions can be selected explicitly)
 - `RUNDECK_TIMEOUT`: Request timeout (seconds)
 - `RUNDECK_SSL_VERIFY`: TLS verification (bool or CA path)
 - `RUNDECK_USER_AGENT`: HTTP User-Agent
 
+Rundeck 6.0+ accepts JSON for REST requests and responses. XML/YAML remain supported only as job, archive, and resource document formats.
+
 Available resources
 -------------------
 - `projects` (`ProjectManager`): CRUD projects, job export/import, project config, archive (export/import).
@@ -77,13 +83,15 @@ Available resources
 - `executions` (`ExecutionManager`): list/filter, running, get/delete, advanced query.
 - `tokens` (`TokenManager`): list, get, create, delete.
 - `users` (`UserManager`): user operations (per current implementation).
-- `metrics` (`MetricsManager`): `/metrics` endpoints (list/data/healthcheck/ping).
+- `metrics` (`MetricsManager`): legacy `/api/V/metrics` endpoints (list/data/healthcheck/ping/threads).
+- `monitoring` (`MonitoringManager`): modern non-versioned `/monitoring/*` endpoints (Prometheus, metrics, health, readiness, info, thread dump).
+- `authorizations` (`AuthorizationsManager`): experimental authorization evaluation endpoints.
 - `plugins` (`PluginManager`): list installed plugins (`/plugin/list`).
 - `webhooks` (`WebhookEventManager` + `ProjectWebhookManager`): project webhook management and sending via token.
 - `key_storage` (`StorageKeyManager`): key storage management `/storage/keys`.
 - `adhoc` (`AdhocManager`, via `project.adhoc`): run AdHoc commands/scripts.
-- `system` (`SystemManager`): system info, executions enable/disable, logstorage, ACL.
-- `config_management` (`ConfigManagementManager`): global configuration `/config`.
+- `system` (`SystemManager`): system info and summary, executions enable/disable, logstorage, ACL.
+- `scheduler` (`SchedulerManager`): scheduled job listing and cluster schedule takeover (Community).
 - `scm` (via `project.scm` and `job.scm`): import/export plugins, setup, enable/disable, status, actions (commit/import/export...).
 
 Return types policy
@@ -92,7 +100,7 @@ Return types policy
 - Factory managers return the created resource object for actions that create it
   (e.g., `project.adhoc` returns `Execution`).
 - Utility managers return raw API responses (dict/str/bytes).
-- `delete(...)` returns `None`.
+- CRUD `delete(...)` returns `None`; action endpoints returning a result body return that raw result.
 - Object methods return raw API responses and update the object in place when needed.
 - Explicit flags are used when an object return is requested (e.g., `as_execution=True`).
 
@@ -104,7 +112,7 @@ Factory managers:
   Returns `Execution` objects (execution factory).
 
 Utility managers:
-- `system`, `config_management`, `metrics`, `scheduler`, `webhooks` (event send).
+- `system`, `metrics`, `scheduler`, `webhooks` (event send), `authorizations` (experimental).
 - `scm` (via `project.scm` and `job.scm`), and project sub-managers like
   `project.config`, `project.resources`, `project.sources`, `project.readme`,
   `project.archive`, `project.acl`.
@@ -112,6 +120,13 @@ Utility managers:
 Note: `project.webhooks.create(...)` returns the raw API response (e.g., `{"msg": "Saved webhook"}`)
 because the Rundeck API does not return the created webhook object.
 
+Migration from 1.1.0
+-------------------
+- Set `api_version=59` explicitly when upgrading a server/client pair gradually; the default is now 59.
+- Remove calls to `rd.config_management` and `job.tags()`: their endpoints are only available in commercial Rundeck products.
+- `rd.scheduler.takeover()` and scheduler job listing remain supported by Community. On a non-cluster server, takeover returns a successful response indicating that no action was performed.
+- `rd.authorizations` wraps experimental endpoints and can change with Rundeck releases.
+
 Example:
 ```python
 job = rd.jobs.get("job-id")          # -> Job (object)
@@ -219,9 +234,11 @@ job.enable_schedule()
 job.disable_schedule()
 info = job.info()
 meta = job.meta(meta="name,description")
-tags = job.tags()
+meta = job.meta(meta="*", meta_exclude="stats")  # API v58+
 workflow = job.workflow()
-forecast = job.forecast(time="2024-05-01T10:00:00Z", max=5)
+forecast = job.forecast(time="2024-05-01T10:00:00Z", max=5, past=False)
+executions = job.executions(include_job_ref=True)
+deleted = job.delete_executions()
 
 # Export/import jobs via manager (project parameter or parent)
 rd.jobs.export(project="demo", format="xml", idlist="id1,id2", groupPath="group")
@@ -422,14 +439,35 @@ if features:
     print(first.name, status.enabled)
 ```
 
-Global configuration `/config`
+Monitoring
+----------
+```python
+# Rundeck 6.0+ modern endpoints, outside /api/V.
+health = rd.monitoring.health()
+prometheus_text = rd.monitoring.prometheus()
+metric = rd.monitoring.metric("jvm.memory.used", tags=["area:heap"])
+thread_dump = rd.monitoring.thread_dump()
+
+# Legacy metrics require rundeck.metrics.legacy.enabled=true on Rundeck 6.0.
+legacy_threads = rd.metrics.threads()
+ready = rd.monitoring.readiness()
+```
+
+Community additions
+-------------------
 ```python
-cfg = rd.config_management
-all_configs = cfg.list()
-cfg.save([{"key": "ui.banner", "value": "Hello"}])
-cfg.delete("ui.banner", strata="default")
-cfg.refresh()
-cfg.restart()
+api_info = rd.api_info()
+summary = rd.system.summary()
+scheduled_jobs = rd.scheduler.jobs()
+rd.tokens.remove_expired("admin")  # use "*" with suitable administrator rights
+
+project = rd.projects.get("demo")
+project.plugins.save("ResourceModelSource", "resources.source", plugins=[])
+project.archive.export_async(execution_ids=["1", "2"], use_post=True)
+project.jobs.validate_option(option_data, job_was_scheduled=False)
+
+# Experimental authorization API; actions are repeated query parameters.
+permissions = rd.authorizations.application_kind("job", ["read", "run"])
 ```
 
 Pagination
@@ -450,11 +488,12 @@ Development and testing
 - Formatting/Lint: `black src/rundeck tests/`, `ruff check src/rundeck tests/`
 - Typing: `mypy src/rundeck/`
 - Tests: `pytest`
-- Local integration tests: `scripts/run-integration.sh` (starts docker compose at repo root, exports by default `RUNDECK_URL=http://localhost:4440`, `RUNDECK_TOKEN=adminToken`, `RUNDECK_API_VERSION=56`, waits for the healthcheck, runs `poetry run pytest -m integration`). You can override env vars before running. Add `KEEP_STACK=1` to keep the instance running after tests. Dedicated teardown script: `scripts/stop-integration.sh`.
+- Local integration tests: `scripts/run-integration.sh` starts Rundeck Community 6.2.1 by default with API v59. Use `RUNDECK_IMAGE=rundeck/rundeck:6.0.1 RUNDECK_API_VERSION=58` or `RUNDECK_IMAGE=rundeck/rundeck:5.18.0 RUNDECK_API_VERSION=56` for compatibility runs. Add `KEEP_STACK=1` to keep the instance running after tests. Dedicated teardown script: `scripts/stop-integration.sh`.
+- The docker compose stack mounts `tokens.properties` at the repo root to seed a local admin token for integration tests. This file is only intended for local testing.
 
 Code structure
 --------------
 - `src/rundeck/base.py`: generic objects/managers, `_build_path` helpers, pagination, CRUD.
 - `src/rundeck/client.py`: HTTP client, `http_get/post/put/delete/list` methods.
-- `src/rundeck/v1/objects/`: domain managers and objects (projects, jobs, executions, system, tokens, users, config_management).
-- Managers/objects schema: we apply the manager -> object pattern wherever the API exposes an identifiable resource (jobs, projects, users, tokens, executions, etc.). For purely global or utility endpoints without a resource (e.g., `/system` and its subdomains, `/config`, `/metrics`), we use dedicated sub-managers rather than forcing an artificial object.
+- `src/rundeck/v1/objects/`: Community domain managers and objects (projects, jobs, executions, system, tokens, users, authorizations).
+- Managers/objects schema: we apply the manager -> object pattern wherever the API exposes an identifiable resource (jobs, projects, users, tokens, executions, etc.). For global or utility endpoints without a resource (e.g., `/system`, `/scheduler`, `/metrics`), we use dedicated sub-managers rather than forcing an artificial object.

{python_rundeck-1.0.1 → python_rundeck-2.0.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "python-rundeck"
-version = "1.0.1"
-description = "Python client for the Rundeck API (v14-v56)."
+version = "2.0.0"
+description = "Python client for the Rundeck Community API (v14-v59)."
 authors = [
     {name = "Pascal Seckinger",email = "pascal.seckinger@protonmail.com"}
 ]

{python_rundeck-1.0.1 → python_rundeck-2.0.0}/src/rundeck/client.py

@@ -1,8 +1,6 @@
-from __future__ import annotations
+"""Client principal pour l'API Rundeck."""
 
-"""
-Client principal pour l'API Rundeck
-"""
+from __future__ import annotations
 
 from typing import Any
 from urllib.parse import urljoin
@@ -37,8 +35,10 @@ class Rundeck:
         api_version: int | None = None,
         timeout: float | None = None,
         ssl_verify: bool | None = None,
+        user_agent: str | None = None,
         session: requests.Session | None = None,
         config_files: list[str] | None = None,
+        config_section: str | None = None,
     ) -> None:
         self.config = RundeckConfig(
             url=url,
@@ -48,7 +48,9 @@ class Rundeck:
             api_version=api_version,
             timeout=timeout,
             ssl_verify=ssl_verify,
+            user_agent=user_agent,
             config_files=config_files,
+            config_section=config_section or "rundeck",
         )
 
         if not self.config.url:
@@ -79,12 +81,12 @@ class Rundeck:
     def _init_managers(self) -> None:
         """Initialise les managers d'objets."""
         # Import paresseux pour éviter les boucles d'import.
-        from rundeck.v1.objects.config_management import ConfigManagementManager
+        from rundeck.v1.objects.authorizations import AuthorizationsManager
         from rundeck.v1.objects.executions import ExecutionManager
         from rundeck.v1.objects.features import FeatureManager
         from rundeck.v1.objects.jobs import JobManager
         from rundeck.v1.objects.key_storage import StorageKeyManager
-        from rundeck.v1.objects.metrics import MetricsManager
+        from rundeck.v1.objects.metrics import MetricsManager, MonitoringManager
         from rundeck.v1.objects.plugins import PluginManager
         from rundeck.v1.objects.projects import ProjectManager
         from rundeck.v1.objects.scheduler import SchedulerManager
@@ -96,8 +98,9 @@ class Rundeck:
         self.projects = ProjectManager(self)
         self.jobs = JobManager(self)
         self.executions = ExecutionManager(self)
-        self.config_management = ConfigManagementManager(self)
+        self.authorizations = AuthorizationsManager(self)
         self.metrics = MetricsManager(self)
+        self.monitoring = MonitoringManager(self)
         self.plugins = PluginManager(self)
         self.webhooks = WebhookEventManager(self)
         self.key_storage = StorageKeyManager(self)
@@ -107,6 +110,10 @@ class Rundeck:
         self.tokens = TokenManager(self)
         self.users = UserManager(self)
 
+    def api_info(self) -> dict[str, Any]:
+        """Récupère les informations de l'API utilisée par ce client."""
+        return self.http_get("/")
+
     @property
     def url(self) -> str:
         """URL fournie par l'utilisateur."""
@@ -127,6 +134,7 @@ class Rundeck:
         cls,
         config_section: str | None = None,
         config_files: list[str] | None = None,
+        user_agent: str | None = None,
         **kwargs: Any,
     ) -> "Rundeck":
         """
@@ -144,8 +152,10 @@ class Rundeck:
             api_version=conf.api_version,
             timeout=conf.timeout,
             ssl_verify=conf.ssl_verify,
+            user_agent=user_agent,
             session=kwargs.get("session"),
             config_files=config_files,
+            config_section=config_section,
         )
 
     def _authenticate_with_password(self) -> None:
@@ -265,14 +275,12 @@ class Rundeck:
         if raw:
             return response
 
-        if method == HTTP_DELETE:
-            return None
         if response.text:
             try:
                 return response.json()
             except ValueError:
                 return response.text
-        return {}
+        return None if method == HTTP_DELETE else {}
 
     def http_get(
         self,
@@ -331,8 +339,8 @@ class Rundeck:
         url: str,
         raw: bool = False,
         **kwargs: Any,
-    ) -> None:
-        self._request(HTTP_DELETE, url, raw=raw, **kwargs)
+    ) -> Any:
+        return self._request(HTTP_DELETE, url, raw=raw, **kwargs)
 
     def __enter__(self) -> "Rundeck":
         return self

{python_rundeck-1.0.1 → python_rundeck-2.0.0}/src/rundeck/config.py

@@ -63,6 +63,7 @@ class RundeckConfig:
         api_version: int | str | None = None,
         timeout: float | None = None,
         ssl_verify: bool | str | None = None,
+        user_agent: str | None = None,
         config_files: list[str] | None = None,
         config_section: str = "rundeck",
     ) -> None:
@@ -103,7 +104,7 @@ class RundeckConfig:
             else _coerce_ssl_verify(env_ssl_verify or file_conf.get("ssl_verify"))
         )
         self.user_agent: str = (
-            env_user_agent or file_conf.get("user_agent") or USER_AGENT
+            user_agent or env_user_agent or file_conf.get("user_agent") or USER_AGENT
         )
         self.config_files = files
 

python_rundeck-2.0.0/src/rundeck/const.py

@@ -0,0 +1,69 @@
+"""
+Constantes partagées pour le client Rundeck.
+"""
+
+import tomllib
+from importlib.metadata import PackageNotFoundError, version
+from pathlib import Path
+
+
+# Package metadata
+def _read_pyproject_version() -> str | None:
+    try:
+        root = Path(__file__).resolve().parents[2]
+        pyproject = root / "pyproject.toml"
+        if not pyproject.is_file():
+            return None
+        with pyproject.open("rb") as handle:
+            data = tomllib.load(handle)
+        return data.get("project", {}).get("version")
+    except Exception:
+        return None
+
+
+try:
+    __version__ = version("python-rundeck")
+except PackageNotFoundError:  # pragma: no cover - fallback for local dev
+    __version__ = _read_pyproject_version() or "0.0.0"
+
+# Auth
+RUNDECK_AUTH_HEADER = "X-Rundeck-Auth-Token"
+
+# HTTP methods
+HTTP_GET = "GET"
+HTTP_POST = "POST"
+HTTP_PUT = "PUT"
+HTTP_DELETE = "DELETE"
+
+# Content / formats
+FORMAT_JSON = "json"
+
+# API versions. The library remains compatible with legacy Rundeck servers
+# using v14, while current Rundeck servers require at least v17.
+API_VERSION_CURRENT = "59"
+API_VERSION_MIN = "14"
+API_VERSION_SERVER_MIN = "17"
+API_VERSION_DEPRECATION = "34"
+
+# Defaults
+DEFAULT_API_VERSION = API_VERSION_CURRENT
+DEFAULT_TIMEOUT = 30
+USER_AGENT = "python-rundeck"
+
+
+__all__ = [
+    "__version__",
+    "API_VERSION_CURRENT",
+    "API_VERSION_DEPRECATION",
+    "API_VERSION_MIN",
+    "API_VERSION_SERVER_MIN",
+    "DEFAULT_API_VERSION",
+    "DEFAULT_TIMEOUT",
+    "FORMAT_JSON",
+    "HTTP_DELETE",
+    "HTTP_GET",
+    "HTTP_POST",
+    "HTTP_PUT",
+    "RUNDECK_AUTH_HEADER",
+    "USER_AGENT",
+]

{python_rundeck-1.0.1 → python_rundeck-2.0.0}/src/rundeck/exceptions.py

@@ -131,7 +131,7 @@ def raise_for_status(response: requests.Response) -> None:
         raise RundeckAuthenticationError(message, error_code, response)
     if code_lower == "api-version-unsupported":
         raise RundeckApiVersionUnsupportedError(message, error_code, response)
-    if status == 400:
+    if status in (400, 422):
         raise RundeckValidationError(message, error_code, response)
     if status in (401, 403):
         raise RundeckAuthenticationError(message, error_code, response)

python_rundeck-2.0.0/src/rundeck/utils.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from typing import Any, Mapping
+
+
+def compact(*dicts: Mapping[str, Any], **kwargs: Any) -> dict[str, Any]:
+    """
+    Supprime les entrées dont la valeur est None.
+    """
+    result: dict[str, Any] = {}
+    for mapping in dicts:
+        if not mapping:
+            continue
+        for key, value in mapping.items():
+            if value is not None:
+                result[key] = value
+    for key, value in kwargs.items():
+        if value is not None:
+            result[key] = value
+    return result
+
+
+def build_headers(
+    accept: str | None = None,
+    content_type: str | None = None,
+) -> dict[str, str] | None:
+    """
+    Construit les en-têtes standards (Accept/Content-Type).
+    """
+    headers: dict[str, str] = {}
+    if accept is not None:
+        headers["Accept"] = accept
+    if content_type is not None:
+        headers["Content-Type"] = content_type
+    return headers or None

python_rundeck-2.0.0/src/rundeck/v1/objects/acl.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import Any
+
+from rundeck.utils import build_headers
+
+
+class YamlPolicyMixin:
+    _yaml_content_type = "application/yaml"
+
+    def _yaml_headers(self) -> dict[str, str]:
+        headers = build_headers(
+            accept=self._yaml_content_type, content_type=self._yaml_content_type
+        )
+        return headers or {
+            "Accept": self._yaml_content_type,
+            "Content-Type": self._yaml_content_type,
+        }
+
+    def _post_yaml(self, path: str, content: Any) -> Any:
+        return self.rd.http_post(path, data=content, headers=self._yaml_headers())
+
+    def _put_yaml(self, path: str, content: Any) -> Any:
+        return self.rd.http_put(path, data=content, headers=self._yaml_headers())