semaphoreui-client 0.1.5__tar.gz → 0.1.7__tar.gz

semaphoreui_client-0.1.7/.github/workflows/checks.yml

@@ -0,0 +1,51 @@
+name: Checks, lints, and other CI
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+jobs:
+  check-types:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install hatch
+      - run: hatch -e types run check
+  check-format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install hatch
+      - run: hatch -e lint run check-format
+  check-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install hatch
+      - run: hatch -e lint run lint
+  maybe-release:
+    runs-on: ubuntu-latest
+    permissions: write-all
+    needs: ["check-types", "check-format", "check-lint"]
+    steps:
+      - uses: actions/checkout@v4
+      - run: gh workflow run release.yml
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        if: startsWith( github.ref, 'refs/tags/')

semaphoreui_client-0.1.7/.github/workflows/pre-release.yml

@@ -0,0 +1,30 @@
+name: Tag a new version
+
+on:
+  workflow_dispatch:
+    inputs:
+        version:
+            description: 'Version to release. Can be a version number, or one of major|minor|patch'
+            required: false
+            default: patch
+
+jobs:
+  bump-version-and-tag:
+    name: Bump the version and tag that new version
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{secrets.PRERELEASE_TOKEN}}
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install hatch
+      - run: |
+          git config --global user.email "paul@eventuallyanyway.com"
+          git config --global user.name "Paul Hummer"
+
+          hatch version ${{ inputs.version }}
+          git commit -a -m "release: bump to version `hatch version`"
+          git tag `hatch version`
+          git push && git push --tags

semaphoreui_client-0.1.7/.github/workflows/release.yml

@@ -0,0 +1,19 @@
+name: Release a software
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install hatch
+      - run: hatch build
+      - uses: pypa/gh-action-pypi-publish@release/v1

{semaphoreui_client-0.1.5 → semaphoreui_client-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: semaphoreui-client
-Version: 0.1.5
+Version: 0.1.7
 Summary: An api client for interacting with Semaphore UI
 Project-URL: Documentation, https://github.com/rockstar/semaphoreui-client#readme
 Project-URL: Issues, https://github.com/rockstar/semaphoreui-client/issues

{semaphoreui_client-0.1.5 → semaphoreui_client-0.1.7}/pyproject.toml

@@ -43,6 +43,17 @@ extra-dependencies = [
 [tool.hatch.envs.types.scripts]
 check = "mypy --install-types --non-interactive {args:semaphoreui_client}"
 
+[tool.hatch.envs.lint]
+extra-dependencies = [
+  "ruff",
+]
+
+[tool.hatch.envs.lint.scripts]
+format = "ruff format semaphoreui_client/"
+check-format = "ruff format --check semaphoreui_client/"
+diff-format = "ruff format --diff semaphoreui_client/"
+lint = "ruff check semaphoreui_client/"
+
 [[tool.hatch.envs.hatch-test.matrix]]
 python = ["3.12", "3.11", "3.9"]
 
@@ -63,4 +74,7 @@ exclude_lines = [
   "no cov",
   "if __name__ == .__main__.:",
   "if TYPE_CHECKING:",
-]
+]
+
+[tool.mypy]
+strict = true

semaphoreui_client-0.1.7/semaphoreui_client/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.1.7"

semaphoreui_client-0.1.7/semaphoreui_client/__init__.py

@@ -0,0 +1 @@
+from .client import SemaphoreUIClient as Client  # NOQA

{semaphoreui_client-0.1.5 → semaphoreui_client-0.1.7}/semaphoreui_client/client.py

@@ -6,8 +6,7 @@ import requests
 
 
 class SemaphoreUIClient:
-
-    def __init__(self, host: str, path: str="/api"):
+    def __init__(self, host: str, path: str = "/api"):
         self.http = requests.Session()
         if host.endswith("/"):
             host = host.strip("/")
@@ -15,7 +14,7 @@ class SemaphoreUIClient:
             path = f"/{path}"
         self.api_endpoint = f"{host}{path}"
 
-    def login(self, user, password):
+    def login(self, user: str, password: str) -> None:
         response = self.http.post(
             f"{self.api_endpoint}/auth/login", json={"auth": user, "password": password}
         )
@@ -24,13 +23,13 @@ class SemaphoreUIClient:
                 f"Username and/or password incorrect. Response from POST /auth/login was {response.status_code}"
             )
 
-    def whoami(self):
+    def whoami(self) -> None:
         response = self.http.get(f"{self.api_endpoint}/auth/login")
-        assert (
-            response.status_code == 200
-        ), f"GET /auth/login return response {response.status_code}"
+        assert response.status_code == 200, (
+            f"GET /auth/login return response {response.status_code}"
+        )
 
-    def logout(self):
+    def logout(self) -> None:
         response = self.http.post(f"{self.api_endpoint}/auth/logout")
         assert response.status_code == 204
 
@@ -44,7 +43,7 @@ class SemaphoreUIClient:
         assert response.status_code == 201
         return Token(**response.json(), client=self)
 
-    def delete_token(self, id):
+    def delete_token(self, id: str) -> None:
         response = self.http.delete(f"{self.api_endpoint}/user/tokens/{id}")
         assert response.status_code in (204, 404)  # 404 if token was already expired
 
@@ -81,7 +80,7 @@ class SemaphoreUIClient:
         assert response.status_code == 201
         return Project(**response.json(), client=self)
 
-    def delete_project(self, id: int):
+    def delete_project(self, id: int) -> None:
         response = self.http.delete(f"{self.api_endpoint}/project/{id}")
         assert response.status_code == 204
 
@@ -92,8 +91,8 @@ class SemaphoreUIClient:
         alert: bool,
         alert_chat: str,
         max_parallel_tasks: int,
-        type: typing.Optional[str]=None,
-    ):
+        type: typing.Optional[str] = None,
+    ) -> None:
         response = self.http.put(
             f"{self.api_endpoint}/project/{id}",
             json={
@@ -126,19 +125,21 @@ class SemaphoreUIClient:
         assert response.status_code == 200
         return [User(**data) for data in response.json()]
 
-    def add_project_user(self, id: int, user: "User"):
+    def add_project_user(self, id: int, user: "User") -> None:
         response = self.http.post(
-            f"{self.api_endpoint}/project/{id}/users", json=user.to_json()  # type: ignore
+            f"{self.api_endpoint}/project/{id}/users",
+            json=user.to_json(),  # type: ignore
         )
         assert response.status_code == 204
 
-    def update_project_user(self, id: int, user: "User"):
+    def update_project_user(self, id: int, user: "User") -> None:
         response = self.http.put(
-            f"{self.api_endpoint}/project/{id}/users/{user.id}", json=user.to_json()  # type: ignore
+            f"{self.api_endpoint}/project/{id}/users/{user.id}",
+            json=user.to_json(),  # type: ignore
         )
         assert response.status_code == 204
 
-    def remove_project_user(self, id: int, user_id: int):
+    def remove_project_user(self, id: int, user_id: int) -> None:
         response = self.http.delete(f"{self.api_endpoint}/project/{id}/users/{user_id}")
         assert response.status_code == 204
 
@@ -159,14 +160,14 @@ class SemaphoreUIClient:
 
     def update_project_integration(
         self, project_id: int, id: int, name: str, template_id: int
-    ):
+    ) -> None:
         response = self.http.put(
             f"{self.api_endpoint}/project/{project_id}/integrations/{id}",
             json={"project_id": project_id, "name": name, "template_id": template_id},
         )
         assert response.status_code == 204
 
-    def delete_project_integration(self, project_id: int, id: int):
+    def delete_project_integration(self, project_id: int, id: int) -> None:
         response = self.http.delete(
             f"{self.api_endpoint}/project/{project_id}/integrations/{id}"
         )
@@ -245,7 +246,7 @@ class SemaphoreUIClient:
                 key for key in self.get_project_keys(project_id) if key.name == name
             ][0]
 
-    def delete_project_key(self, project_id: int, id: int):
+    def delete_project_key(self, project_id: int, id: int) -> None:
         response = self.http.delete(
             f"{self.api_endpoint}/project/{project_id}/keys/{id}"
         )
@@ -281,7 +282,7 @@ class SemaphoreUIClient:
                 if repo.name == name
             ][0]
 
-    def delete_project_repository(self, project_id: int, id: int):
+    def delete_project_repository(self, project_id: int, id: int) -> None:
         response = self.http.delete(
             f"{self.api_endpoint}/project/{project_id}/repositories/{id}"
         )
@@ -324,7 +325,7 @@ class SemaphoreUIClient:
                 if env.name == name
             ][0]
 
-    def delete_project_environment(self, project_id: int, id: int):
+    def delete_project_environment(self, project_id: int, id: int) -> None:
         response = self.http.delete(
             f"{self.api_endpoint}/project/{project_id}/environment/{id}"
         )
@@ -343,7 +344,7 @@ class SemaphoreUIClient:
         assert response.status_code == 201
         return View(**response.json(), client=self)
 
-    def delete_project_view(self, project_id: int, id: int):
+    def delete_project_view(self, project_id: int, id: int) -> None:
         response = self.http.delete(
             f"{self.api_endpoint}/project/{project_id}/views/{id}"
         )
@@ -380,7 +381,7 @@ class SemaphoreUIClient:
         assert response.status_code == 201
         return Inventory(**response.json(), client=self)
 
-    def delete_project_inventory(self, project_id: int, id: int):
+    def delete_project_inventory(self, project_id: int, id: int) -> None:
         response = self.http.delete(
             f"{self.api_endpoint}/project/{project_id}/inventory/{id}"
         )
@@ -440,12 +441,12 @@ class SemaphoreUIClient:
                 "autorun": autorun,
             },
         )
-        assert (
-            response.status_code == 201
-        ), f"Expected response code 201, got {response.status_code}"
+        assert response.status_code == 201, (
+            f"Expected response code 201, got {response.status_code}"
+        )
         return Template(**response.json(), client=self)
 
-    def delete_project_template(self, project_id: int, id: int):
+    def delete_project_template(self, project_id: int, id: int) -> None:
         response = self.http.delete(
             f"{self.api_endpoint}/project/{project_id}/templates/{id}"
         )
@@ -463,7 +464,7 @@ class SemaphoreUIClient:
         name: str,
         cron_format: str,
         active: bool = True,
-    ):
+    ) -> "Schedule":
         response = self.http.post(
             f"{self.api_endpoint}/project/{project_id}/schedules",
             json={
@@ -486,7 +487,7 @@ class SemaphoreUIClient:
         name: str,
         cron_format: str,
         active: bool,
-    ):
+    ) -> None:
         response = self.http.post(
             f"{self.api_endpoint}/project/{project_id}/schedules",
             json={
@@ -499,9 +500,8 @@ class SemaphoreUIClient:
             },
         )
         assert response.status_code == 201
-        return Schedule(**response.json(), client=self)
 
-    def delete_project_schedule(self, project_id: int, schedule_id: int):
+    def delete_project_schedule(self, project_id: int, schedule_id: int) -> None:
         response = self.http.delete(
             f"{self.api_endpoint}/project/{project_id}/schedules/{schedule_id}"
         )
@@ -519,12 +519,12 @@ class Integration:
 
     client: SemaphoreUIClient
 
-    def save(self):
+    def save(self) -> None:
         self.client.update_project_integration(
             self.project_id, self.id, self.name, self.template_id
         )
 
-    def delete(self):
+    def delete(self) -> None:
         self.client.delete_project_integration(self.project_id, self.id)
 
 
@@ -539,7 +539,7 @@ class Token:
 
     client: SemaphoreUIClient
 
-    def delete(self):
+    def delete(self) -> None:
         self.client.delete_token(self.id)
 
 
@@ -557,10 +557,10 @@ class Project:
 
     client: SemaphoreUIClient
 
-    def delete(self):
+    def delete(self) -> None:
         self.client.delete_project(self.id)
 
-    def save(self):
+    def save(self) -> None:
         self.client.update_project(
             self.id,
             self.name,
@@ -570,25 +570,25 @@ class Project:
             self.type,
         )
 
-    def backup(self):
+    def backup(self) -> "ProjectBackup":
         return self.client.backup_project(self.id)
 
-    def role(self):
+    def role(self) -> "Permissions":
         return self.client.get_project_role(self.id)
 
-    def events(self):
+    def events(self) -> typing.List["Event"]:
         return self.client.get_project_events(self.id)
 
-    def users(self, sort: str, order: str):
+    def users(self, sort: str, order: str) -> typing.List["User"]:
         return self.client.get_project_users(self.id, sort, order)
 
-    def add_user(self, user: "User"):
+    def add_user(self, user: "User") -> None:
         return self.client.add_project_user(self.id, user)
 
-    def remove_user(self, user_id: int):
+    def remove_user(self, user_id: int) -> None:
         return self.client.remove_project_user(self.id, user_id)
 
-    def update_user(self, user: "User"):
+    def update_user(self, user: "User") -> None:
         return self.client.update_project_user(self.id, user)
 
     def keys(self) -> typing.List["Key"]:
@@ -601,7 +601,7 @@ class Project:
         override_secret: bool = False,
         login_password: typing.Optional[typing.Tuple[str, str]] = None,
         ssh: typing.Optional[typing.Tuple[str, str, str]] = None,
-    ):
+    ) -> "Key":
         return self.client.create_project_key(
             self.id, name, key_type, override_secret, login_password, ssh
         )
@@ -769,22 +769,7 @@ class Key:
 
     client: SemaphoreUIClient
 
-    @classmethod
-    def from_dict(cls, **keys) -> "Key":
-        ssh = KeySsh(
-            login=keys["ssh"]["login"],
-            passphrase=keys["ssh"]["passphrase"],
-            private_key=keys["ssh"]["private_key"],
-        )
-        login_password = KeyLoginPassword(
-            login=keys["login_password"]["login"],
-            password=keys["login_password"]["password"],
-        )
-        del keys["ssh"]
-        del keys["login_password"]
-        return cls(**keys, ssh=ssh, login_password=login_password)
-
-    def delete(self):
+    def delete(self) -> None:
         self.client.delete_project_key(self.project_id, self.id)
 
 
@@ -799,7 +784,7 @@ class Repository:
 
     client: SemaphoreUIClient
 
-    def delete(self):
+    def delete(self) -> None:
         self.client.delete_project_repository(self.project_id, self.id)
 
 
@@ -822,7 +807,7 @@ class Environment:
 
     client: SemaphoreUIClient
 
-    def delete(self):
+    def delete(self) -> None:
         self.client.delete_project_environment(self.project_id, self.id)
 
 
@@ -835,7 +820,7 @@ class View:
 
     client: SemaphoreUIClient
 
-    def delete(self):
+    def delete(self) -> None:
         self.client.delete_project_view(self.project_id, self.id)
 
 
@@ -854,7 +839,7 @@ class Inventory:
 
     client: SemaphoreUIClient
 
-    def delete(self):
+    def delete(self) -> None:
         self.client.delete_project_inventory(self.project_id, self.id)
 
 
@@ -884,7 +869,7 @@ class Template:
 
     client: SemaphoreUIClient
 
-    def delete(self):
+    def delete(self) -> None:
         self.client.delete_project_template(self.project_id, self.id)
 
 
@@ -900,7 +885,7 @@ class Schedule:
 
     client: SemaphoreUIClient
 
-    def save(self):
+    def save(self) -> None:
         self.client.update_project_schedule(
             self.project_id,
             self.id,
@@ -910,5 +895,5 @@ class Schedule:
             self.active,
         )
 
-    def delete(self):
+    def delete(self) -> None:
         self.client.delete_project_schedule(self.project_id, self.id)

semaphoreui_client-0.1.5/.env/.gitignore

@@ -1,2 +0,0 @@
-# created by virtualenv automatically
-*

semaphoreui_client-0.1.5/.env/bin/activate

@@ -1,87 +0,0 @@
-# This file must be used with "source bin/activate" *from bash*
-# you cannot run it directly
-
-
-if [ "${BASH_SOURCE-}" = "$0" ]; then
-    echo "You must source this script: \$ source $0" >&2
-    exit 33
-fi
-
-deactivate () {
-    unset -f pydoc >/dev/null 2>&1 || true
-
-    # reset old environment variables
-    # ! [ -z ${VAR+_} ] returns true if VAR is declared at all
-    if ! [ -z "${_OLD_VIRTUAL_PATH:+_}" ] ; then
-        PATH="$_OLD_VIRTUAL_PATH"
-        export PATH
-        unset _OLD_VIRTUAL_PATH
-    fi
-    if ! [ -z "${_OLD_VIRTUAL_PYTHONHOME+_}" ] ; then
-        PYTHONHOME="$_OLD_VIRTUAL_PYTHONHOME"
-        export PYTHONHOME
-        unset _OLD_VIRTUAL_PYTHONHOME
-    fi
-
-    # The hash command must be called to get it to forget past
-    # commands. Without forgetting past commands the $PATH changes
-    # we made may not be respected
-    hash -r 2>/dev/null
-
-    if ! [ -z "${_OLD_VIRTUAL_PS1+_}" ] ; then
-        PS1="$_OLD_VIRTUAL_PS1"
-        export PS1
-        unset _OLD_VIRTUAL_PS1
-    fi
-
-    unset VIRTUAL_ENV
-    unset VIRTUAL_ENV_PROMPT
-    if [ ! "${1-}" = "nondestructive" ] ; then
-    # Self destruct!
-        unset -f deactivate
-    fi
-}
-
-# unset irrelevant variables
-deactivate nondestructive
-
-VIRTUAL_ENV='/Users/rockstar/Projects/semaphoreui-client/.env'
-if ([ "$OSTYPE" = "cygwin" ] || [ "$OSTYPE" = "msys" ]) && $(command -v cygpath &> /dev/null) ; then
-    VIRTUAL_ENV=$(cygpath -u "$VIRTUAL_ENV")
-fi
-export VIRTUAL_ENV
-
-_OLD_VIRTUAL_PATH="$PATH"
-PATH="$VIRTUAL_ENV/bin:$PATH"
-export PATH
-
-if [ "x" != x ] ; then
-    VIRTUAL_ENV_PROMPT=""
-else
-    VIRTUAL_ENV_PROMPT=$(basename "$VIRTUAL_ENV")
-fi
-export VIRTUAL_ENV_PROMPT
-
-# unset PYTHONHOME if set
-if ! [ -z "${PYTHONHOME+_}" ] ; then
-    _OLD_VIRTUAL_PYTHONHOME="$PYTHONHOME"
-    unset PYTHONHOME
-fi
-
-if [ -z "${VIRTUAL_ENV_DISABLE_PROMPT-}" ] ; then
-    _OLD_VIRTUAL_PS1="${PS1-}"
-    PS1="(${VIRTUAL_ENV_PROMPT}) ${PS1-}"
-    export PS1
-fi
-
-# Make sure to unalias pydoc if it's already there
-alias pydoc 2>/dev/null >/dev/null && unalias pydoc || true
-
-pydoc () {
-    python -m pydoc "$@"
-}
-
-# The hash command must be called to get it to forget past
-# commands. Without forgetting past commands the $PATH changes
-# we made may not be respected
-hash -r 2>/dev/null

semaphoreui_client-0.1.5/.env/bin/activate.csh

@@ -1,55 +0,0 @@
-# This file must be used with "source bin/activate.csh" *from csh*.
-# You cannot run it directly.
-# Created by Davide Di Blasi <davidedb@gmail.com>.
-
-set newline='\
-'
-
-alias deactivate 'test $?_OLD_VIRTUAL_PATH != 0 && setenv PATH "$_OLD_VIRTUAL_PATH:q" && unset _OLD_VIRTUAL_PATH; rehash; test $?_OLD_VIRTUAL_PROMPT != 0 && set prompt="$_OLD_VIRTUAL_PROMPT:q" && unset _OLD_VIRTUAL_PROMPT; unsetenv VIRTUAL_ENV; unsetenv VIRTUAL_ENV_PROMPT; test "\!:*" != "nondestructive" && unalias deactivate && unalias pydoc'
-
-# Unset irrelevant variables.
-deactivate nondestructive
-
-setenv VIRTUAL_ENV '/Users/rockstar/Projects/semaphoreui-client/.env'
-
-set _OLD_VIRTUAL_PATH="$PATH:q"
-setenv PATH "$VIRTUAL_ENV:q/bin:$PATH:q"
-
-
-
-if ('' != "") then
-    setenv VIRTUAL_ENV_PROMPT ''
-else
-    setenv VIRTUAL_ENV_PROMPT "$VIRTUAL_ENV:t:q"
-endif
-
-if ( $?VIRTUAL_ENV_DISABLE_PROMPT ) then
-    if ( $VIRTUAL_ENV_DISABLE_PROMPT == "" ) then
-        set do_prompt = "1"
-    else
-        set do_prompt = "0"
-    endif
-else
-    set do_prompt = "1"
-endif
-
-if ( $do_prompt == "1" ) then
-    # Could be in a non-interactive environment,
-    # in which case, $prompt is undefined and we wouldn't
-    # care about the prompt anyway.
-    if ( $?prompt ) then
-        set _OLD_VIRTUAL_PROMPT="$prompt:q"
-        if ( "$prompt:q" =~ *"$newline:q"* ) then
-            :
-        else
-            set prompt = '('"$VIRTUAL_ENV_PROMPT:q"') '"$prompt:q"
-        endif
-    endif
-endif
-
-unset env_name
-unset do_prompt
-
-alias pydoc python -m pydoc
-
-rehash