python-jcli 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

jcli/sdk/system.py

@@ -1,202 +0,0 @@
-"""Jenkins System SDK functions.
-
-All functions take a :class:`~jcli.sdk.client.JenkinsClient` as the first argument.
-"""
-
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, Any
-
-if TYPE_CHECKING:
-    from jcli.sdk.client import JenkinsClient
-
-# ------------------------------------------------------------------
-# Public API
-# ------------------------------------------------------------------
-
-
-def get_system_info(client: "JenkinsClient") -> dict[str, Any]:
-    """Get Jenkins system information.
-
-    Calls ``GET /api/json`` and extracts version from the ``X-Jenkins``
-    response header.
-
-    Args:
-        client: Authenticated Jenkins API client.
-
-    Returns:
-        Dictionary with keys:
-        - ``version``: Jenkins version string (from ``X-Jenkins`` header).
-        - ``num_executors``: Total number of executors.
-        - ``mode``: Executor mode (e.g. ``NORMAL``, ``EXCLUSIVE``).
-        - ``quietingDown``: Whether Jenkins is in quiet-down mode.
-        - ``slaveAgentPort``: Port for JNLP agents.
-        - ``num_nodes``: Total number of connected nodes (from ``computer``).
-        - ``num_jobs``: Total number of jobs.
-        - ``raw``: Full API response data.
-    """
-    resp = client.request("GET", "/api/json")
-    data: dict[str, Any] = resp.json()
-
-    version = resp.headers.get("X-Jenkins", "unknown")
-
-    # Count nodes from computer list if available
-    num_nodes = 0
-    computer = data.get("computer", [])
-    if isinstance(computer, list):
-        num_nodes = len(computer)
-
-    return {
-        "version": version,
-        "num_executors": data.get("numExecutors", 0),
-        "mode": data.get("mode", ""),
-        "quietingDown": data.get("quietingDown", False),
-        "slaveAgentPort": data.get("slaveAgentPort", 0),
-        "num_nodes": num_nodes,
-        "num_jobs": len(data.get("jobs", [])),
-        "raw": data,
-    }
-
-
-def safe_restart(client: "JenkinsClient") -> bool:
-    """Trigger a safe restart of Jenkins.
-
-    Calls ``POST /safeRestart``. Jenkins waits for running builds to
-    complete before restarting.
-
-    Args:
-        client: Authenticated Jenkins API client.
-
-    Returns:
-        ``True`` on success (HTTP 200/302).
-    """
-    resp = client.request("POST", "/safeRestart")
-    return resp.ok
-
-
-def quiet_down(client: "JenkinsClient", reason: str = "") -> bool:
-    """Put Jenkins into quiet-down mode.
-
-    In quiet-down mode, Jenkins stops scheduling new builds. Running
-    builds continue until finished.  Calls ``POST /quietDown``.
-
-    Args:
-        client: Authenticated Jenkins API client.
-        reason: Optional reason shown on the quiet-down banner.
-
-    Returns:
-        ``True`` on success (HTTP 200/302).
-    """
-    params: dict[str, str] | None = None
-    if reason:
-        params = {"reason": reason}
-    resp = client.request("POST", "/quietDown", params=params)
-    return resp.ok
-
-
-def cancel_quiet_down(client: "JenkinsClient") -> bool:
-    """Cancel quiet-down mode, allowing Jenkins to resume scheduling builds.
-
-    Calls ``POST /cancelQuietDown``.
-
-    Args:
-        client: Authenticated Jenkins API client.
-
-    Returns:
-        ``True`` on success (HTTP 200/302).
-    """
-    resp = client.request("POST", "/cancelQuietDown")
-    return resp.ok
-
-
-def run_script(client: "JenkinsClient", script: str) -> Any:
-    """Execute a Groovy script on the Jenkins server.
-
-    Calls ``POST /scriptText`` with form-encoded script content.
-
-    Args:
-        client: Jenkins API client.
-        script: Groovy script text.
-
-    Returns:
-        Script output as text.
-    """
-    resp = client.post_data("/scriptText", data={"script": script})
-    return resp.text
-
-
-def get_system_load(client: "JenkinsClient") -> dict[str, Any]:
-    """Get current system load statistics.
-
-    Calls ``GET /queue/api/json`` for the build queue and
-    ``GET /computer/api/json`` for executor usage.
-
-    Args:
-        client: Authenticated Jenkins API client.
-
-    Returns:
-        Dictionary with keys:
-        - ``queue_length``: Number of items in the build queue.
-        - ``total_executors``: Total executors across all nodes.
-        - ``busy_executors``: Currently busy executors.
-        - ``idle_executors``: Currently idle executors.
-    """
-    queue_data = client.get_json("/queue/api/json")
-    queue_items = queue_data.get("items", [])
-    queue_length = len(queue_items) if isinstance(queue_items, list) else 0
-
-    computer_data = client.get_json("/computer/api/json")
-    computers = computer_data.get("computer", [])
-    total_executors = 0
-    busy_executors = 0
-    if isinstance(computers, list):
-        for c in computers:
-            total_executors += c.get("numExecutors", 0)
-            busy = c.get("busyExecutors", 0)
-            if busy:
-                busy_executors += busy
-
-    idle_executors = total_executors - busy_executors
-
-    return {
-        "queue_length": queue_length,
-        "total_executors": total_executors,
-        "busy_executors": busy_executors,
-        "idle_executors": idle_executors,
-    }
-
-
-def list_users(client: "JenkinsClient") -> Any:
-    """List all Jenkins users.
-
-    Calls ``GET /asynchPeople/api/json``.
-
-    Args:
-        client: Authenticated Jenkins API client.
-
-    Returns:
-        Parsed JSON with users list.
-    """
-    return client.get_json("/asynchPeople/api/json")
-
-
-def generate_token(
-    client: "JenkinsClient",
-    username: str,
-    token_name: str = "jcli-generated",
-) -> Any:
-    """Generate a new API token for a user.
-
-    Calls ``POST /user/{name}/descriptorByName/jenkins.security.ApiTokenProperty/generateNewToken``.
-
-    Args:
-        client: Authenticated Jenkins API client.
-        username: Jenkins username.
-        token_name: Name/label for the new token.
-
-    Returns:
-        Parsed JSON with token data including the token value.
-    """
-    path = f"/user/{username}/descriptorByName/jenkins.security.ApiTokenProperty/generateNewToken"
-    data = {"newTokenName": token_name}
-    return client.post_data(path, data=data).json()

jcli/sdk/view.py

@@ -1,94 +0,0 @@
-"""SDK functions for Jenkins View management."""
-
-from __future__ import annotations
-
-from typing import Any
-
-from jcli.sdk.client import JenkinsClient
-from jcli.sdk.exceptions import JenkinsAPIError
-
-
-def list_views(client: JenkinsClient) -> list[dict[str, Any]]:
-    """List all views on the Jenkins server.
-
-    Args:
-        client: Authenticated Jenkins client.
-
-    Returns:
-        List of view dicts, each with ``name``, ``url``, and ``jobs`` keys.
-
-    Raises:
-        JenkinsAPIError: If the API request fails.
-    """
-    data = client.get_json("/api/json", tree="views[name,url,jobs[name]]")
-    return data.get("views", [])
-
-
-def get_view(client: JenkinsClient, name: str) -> dict[str, Any]:
-    """Get details for a single Jenkins view.
-
-    Args:
-        client: Authenticated Jenkins client.
-        name: View name.
-
-    Returns:
-        View detail dict.
-
-    Raises:
-        JenkinsAPIError: If the API request fails.
-        JenkinsNotFoundError: If the view doesn't exist.
-    """
-    return client.get_json(f"/view/{name}/api/json")
-
-
-def create_view(
-    client: JenkinsClient,
-    name: str,
-    config_xml: str,
-) -> None:
-    """Create a new Jenkins view.
-
-    Args:
-        client: Authenticated Jenkins client.
-        name: View name to create.
-        config_xml: XML configuration for the view.
-
-    Raises:
-        JenkinsAPIError: If the API request fails (e.g. view already exists).
-    """
-    client.post_xml(f"/createView?name={name}", config_xml)
-
-
-def update_view(
-    client: JenkinsClient,
-    name: str,
-    config_xml: str | bytes,
-) -> Any:
-    """Update a view's configuration.
-
-    Args:
-        client: Jenkins API client.
-        name: View name.
-        config_xml: New XML configuration.
-
-    Returns:
-        Response from Jenkins.
-
-    Raises:
-        JenkinsAPIError: If the API request fails.
-    """
-    return client.post_xml(f"/view/{name}/config.xml", config_xml)
-
-
-def delete_view(client: JenkinsClient, name: str) -> None:
-    """Delete an existing Jenkins view.
-
-    Args:
-        client: Authenticated Jenkins client.
-        name: View name to delete.
-
-    Raises:
-        JenkinsAPIError: If the API request fails.
-        JenkinsNotFoundError: If the view doesn't exist.
-    """
-    client.post_data(f"/view/{name}/doDelete", data="")

python_jcli-1.0.0.dist-info/RECORD

@@ -1,44 +0,0 @@
-jcli/__init__.py,sha256=J-j-u0itpEFT6irdmWmixQqYMadNl1X91TxUmoiLHMI,22
-jcli/__main__.py,sha256=ARL8XYr45T4pIf0gnyCCbK8uljcn1LF7TKcFapxHt_k,34
-jcli/cli.py,sha256=cg45uwYAW2IsdilPffCBSWK7RE2ragnKJ2xiYp9_m94,21175
-jcli/cli_helpers.py,sha256=8GsvEwmaqS8p9Rpx7d_b3_i_Pwag8zsJNNbunxgNXS0,1831
-jcli/plugins/__init__.py,sha256=I6vTpfYO3gIwHoNu5V-sOIdpT_g-bAy4RXR3TW3-k1U,1054
-jcli/plugins/build.py,sha256=60F0UPMFy_eZznBeAIM0XwCcQ3pAuJJjacGaCXxOlcI,6032
-jcli/plugins/config.py,sha256=OEl8X5zrYIBRHhBx1s6GokqBZ2yKRLYgMOVJjjbZgho,8302
-jcli/plugins/credential.py,sha256=ZLdKXoU1ZResv0FqWOH6XWNfb5iSi1rg3dFX1VZPd10,6415
-jcli/plugins/job.py,sha256=dq5jbAn8ZjtYNqJlo7u-0iORubMdZMB2sj4GVK01xoU,12872
-jcli/plugins/node.py,sha256=nwUDYvev9R_BOoYHVmNvNp3vhrmZAXVFN2z_-F_iO7I,4776
-jcli/plugins/pipeline.py,sha256=vTtLk0tPiMSwy2CsCEmtQMhbt9baFoxAqGCSyHtOmOc,3049
-jcli/plugins/plugin.py,sha256=0LMaPjr5jpZokOLENt0rDi_Klk4JYcw8uUzZUceDYvk,4713
-jcli/plugins/skills.py,sha256=5Nw3kPLbx82-8ackdXVLnIL09jziv53jhMZ2sCqYihk,14921
-jcli/plugins/system.py,sha256=2ojwBOsaiuNKmuiTLvU6GpLeSI3-kccy1QjpHuX_8vE,4938
-jcli/plugins/view.py,sha256=eH7pCe7Tw1rC4kVBZDxHqVd3ZrXYLlVxNGPjWvhgw8Q,4475
-jcli/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-jcli/sdk/build.py,sha256=xNMPOCL-RUBQo7OJDuaIZ-DtnxN15kZbyO_insEiklM,5309
-jcli/sdk/client.py,sha256=hnBZcS82ziPyHepPWq7femUqQppw8QCtwbdMrWYVrxc,8723
-jcli/sdk/config.py,sha256=fSBTWqE0i8jpzmtGfo2M-Ln2Y5eQRQD0StS76glyCsI,6992
-jcli/sdk/credential.py,sha256=ayasSZjfn62Z1E6Rc15mqeqN0LyQ1wzO2OBsmlXY7Kk,4009
-jcli/sdk/exceptions.py,sha256=zv5oYOr_t0rma4lVudLp3gLdL5idSzlKGc7g2MowcL0,1737
-jcli/sdk/job.py,sha256=SLuCWdmKm9Y-hh1-TGGNCtELbFen8o6kt4nn4q1BqGg,4877
-jcli/sdk/job_templates.py,sha256=IDQFvlLjMxDP1sLfZUHSo6karjVKu9rsb3dZlMmXqpM,4021
-jcli/sdk/node.py,sha256=N7VTTxXhZKtik2Pn5tJMLoVkqz7iI5BDc-4o8u_c4Ig,4032
-jcli/sdk/pipeline.py,sha256=NLUNC8thSfHWc9_hf5N6wpeeHNlAFLj74Crb5HZmPG8,3515
-jcli/sdk/plugin.py,sha256=kKmxVPgV66sEUAc9J85-E8edY3qpcTw1M4FY_7OUqW8,4671
-jcli/sdk/system.py,sha256=L5PHlrjs-5_PFFOQ9IBA-vMwgQyqq33TfJidTcs0VSQ,6022
-jcli/sdk/view.py,sha256=5Poo50l3eY9ivef3hs0CyL-K39qDk39XQuX7gEHHRlA,2300
-jcli/sdk/output/__init__.py,sha256=Rt0F77oq24tqHvTDV4HyWKAjDtOyPOh9m7ucFy7B77s,70
-jcli/sdk/output/formatter.py,sha256=OUjQxeD-2iSNncuuRaLa01qLi899ux3F39KNkc8ik2Q,3876
-jcli/skills/jcli/SKILL.md,sha256=X9xHxRvNa4F3hUN8bhckBXAJZx2MWY58hGqqd0y158M,3040
-jcli/skills/jcli/auth/SKILL.md,sha256=4_DLD51SwKTXh2Xi0UiQbqG4uXw7qIKv2SOOopS2Qn0,1996
-jcli/skills/jcli/credential/SKILL.md,sha256=3VsVdGalsIySvGfFO79IdL0b5OjF7kJBS9_4P56Wt2A,1244
-jcli/skills/jcli/job/SKILL.md,sha256=bmGyiyLXS2n395bA31gehcMRe094SUBq-FzUlUDvpQM,2066
-jcli/skills/jcli/node/SKILL.md,sha256=k4qi6ApspdIlBcxb0v2ItPrPwT7d9AnFq4N-vGhGcqY,1247
-jcli/skills/jcli/pipeline/SKILL.md,sha256=kUwnxBCUx53zi7efVgtJg9ainO-YuX3griaCqoUyzxU,1231
-jcli/skills/jcli/plugin/SKILL.md,sha256=--1t5LekIHAtnCWUnsQ9BKkPIgAQ7n-p7_QGd8H2jbI,1178
-jcli/skills/jcli/system/SKILL.md,sha256=SHdcLbaJyifjt4KJlmdcHdYLsFGwpF-6lqiWdYpw3co,1932
-jcli/skills/jcli/view/SKILL.md,sha256=f2QZEzvFocIlR7Yh0RKnp5y4sijwUJU_1fxiW7gKJcA,1047
-python_jcli-1.0.0.dist-info/METADATA,sha256=9A7W8m365rFW8_iTXqwPA9VFDE-YUmNvdLR-7BKH7qs,12497
-python_jcli-1.0.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
-python_jcli-1.0.0.dist-info/entry_points.txt,sha256=g-Gb8voGH3Ru4NEoCUMJXJiMZMapdAfYi6Xt1phyFi4,39
-python_jcli-1.0.0.dist-info/top_level.txt,sha256=WFqrbWSEfhvQfbN2m-_Wi5KKCwv1_23LhzPUqo7AdQc,5
-python_jcli-1.0.0.dist-info/RECORD,,