pjdev-gitlab 5.0.0__tar.gz

pjdev_gitlab-5.0.0/.gitignore

@@ -0,0 +1,168 @@
+.DS_Store
+.idea
+
+!**/.gitkeep
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+**/uv.lock
+!./uv.lock

pjdev_gitlab-5.0.0/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026-present Chris O'Neill <chris@purplejay.io>
+
+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.

pjdev_gitlab-5.0.0/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: pjdev-gitlab
+Version: 5.0.0
+Project-URL: Documentation, https://gitlab.purplejay.io/keystone/python/-/tree/main/pjdev-gitlab/README.md
+Project-URL: Issues, https://gitlab.purplejay.io/keystone/python/-/issues
+Project-URL: Source, https://gitlab.purplejay.io/keystone/python
+Author-email: Purple Jay LLC <developers@purplejay.io>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.12
+Requires-Dist: httpx
+Requires-Dist: loguru
+Requires-Dist: pydantic-settings>=2.13.1
+Requires-Dist: pydantic>=2.12.5
+Provides-Extra: dev
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Requires-Dist: respx; extra == 'test'
+Description-Content-Type: text/markdown
+
+# pjdev-gitlab
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pjdev-gitlab.svg)](https://pypi.org/project/pjdev-gitlab)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pjdev-gitlab.svg)](https://pypi.org/project/pjdev-gitlab)
+
+Async GitLab automation SDK. Wraps the GitLab REST API v4 directly with `httpx.AsyncClient` and Pydantic models. Covers issues, merge requests, repository files, and the generic package registry.
+
+-----
+
+## Installation
+
+```console
+pip install pjdev-gitlab
+```
+
+## Configuration
+
+`pjdev-gitlab` reads `GL_*` environment variables (or accepts the same values
+via `init()`):
+
+| variable | required | purpose |
+| --- | --- | --- |
+| `GL_TOKEN` | yes | personal/group/project access token (`api` scope) |
+| `GL_GITLAB_URL` | yes | base URL, e.g. `https://gitlab.com` |
+| `GL_DEFAULT_PROJECT_ID` | no | default project for service helpers |
+| `GL_OUTPUT_PATH` | no | directory for downloaded files |
+
+### Recommended: 1Password + `op run`
+
+On a developer laptop, keep the token in 1Password and inject it into the host
+process with [`op run`](https://developer.1password.com/docs/cli/secrets-environment-variables/) —
+the secret never sits in your shell environment or on disk in plaintext.
+
+1. Install the 1Password CLI (`brew install --cask 1password-cli`) and turn on
+   **Settings → Developer → Integrate with 1Password CLI** in the desktop app.
+2. Store the token in 1Password (e.g. an API Credential titled
+   `GitLab — purplejay` with a `credential` field).
+3. Drop a committable `.env.op` next to your project — references only, no
+   real secrets:
+
+   ```bash
+   # .env.op
+   GL_TOKEN="op://Private/GitLab — purplejay/credential"
+   GL_GITLAB_URL="https://gitlab.purplejay.io"
+   ```
+
+4. Launch your script — or the entire Claude Code session that will use this
+   library — under `op run`:
+
+   ```bash
+   op run --env-file=.env.op -- python my_script.py
+   op run --env-file=.env.op -- claude
+   ```
+
+`op run` resolves the references, exports them to the subprocess, and tears
+them down on exit. Inside Python, just call `config_service.init()` with no
+arguments and the values flow in from the environment.
+
+In CI, skip 1Password and set `GL_TOKEN`/`GL_GITLAB_URL` from the job's
+existing variables (e.g. `CI_JOB_TOKEN` for project-scoped operations).
+
+## Usage
+
+```python
+import asyncio
+from pjdev_gitlab import config_service, issues_service
+from pjdev_gitlab.models import StateEvent
+
+async def main() -> None:
+    # Token & URL come from GL_TOKEN / GL_GITLAB_URL (e.g. via `op run`).
+    config_service.init(default_project_id="my-group/my-project")
+
+    issue = await issues_service.create_issue(
+        project_id="my-group/my-project",
+        title="Bug: timeout on /widgets",
+        description="The endpoint times out under load.\n\n/label ~bug ~priority::high",
+        labels=["bug"],
+    )
+    await issues_service.comment_on_issue(
+        project_id="my-group/my-project",
+        issue_iid=issue.iid,
+        body="Investigating now.",
+    )
+    await issues_service.set_issue_state(
+        project_id="my-group/my-project",
+        issue_iid=issue.iid,
+        state_event=StateEvent.close,
+    )
+
+asyncio.run(main())
+```
+
+Run it: `op run --env-file=.env.op -- python my_script.py`.
+
+## Bundled agent skills
+
+Skill files for AI agents ship under `.agents/skills/` inside the installed package, following the [library-skills.io](https://library-skills.io/create/) convention. Topics: issues, merge requests, repository files, generic packages.
+
+## License
+
+`pjdev-gitlab` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

pjdev_gitlab-5.0.0/README.md

@@ -0,0 +1,101 @@
+# pjdev-gitlab
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pjdev-gitlab.svg)](https://pypi.org/project/pjdev-gitlab)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pjdev-gitlab.svg)](https://pypi.org/project/pjdev-gitlab)
+
+Async GitLab automation SDK. Wraps the GitLab REST API v4 directly with `httpx.AsyncClient` and Pydantic models. Covers issues, merge requests, repository files, and the generic package registry.
+
+-----
+
+## Installation
+
+```console
+pip install pjdev-gitlab
+```
+
+## Configuration
+
+`pjdev-gitlab` reads `GL_*` environment variables (or accepts the same values
+via `init()`):
+
+| variable | required | purpose |
+| --- | --- | --- |
+| `GL_TOKEN` | yes | personal/group/project access token (`api` scope) |
+| `GL_GITLAB_URL` | yes | base URL, e.g. `https://gitlab.com` |
+| `GL_DEFAULT_PROJECT_ID` | no | default project for service helpers |
+| `GL_OUTPUT_PATH` | no | directory for downloaded files |
+
+### Recommended: 1Password + `op run`
+
+On a developer laptop, keep the token in 1Password and inject it into the host
+process with [`op run`](https://developer.1password.com/docs/cli/secrets-environment-variables/) —
+the secret never sits in your shell environment or on disk in plaintext.
+
+1. Install the 1Password CLI (`brew install --cask 1password-cli`) and turn on
+   **Settings → Developer → Integrate with 1Password CLI** in the desktop app.
+2. Store the token in 1Password (e.g. an API Credential titled
+   `GitLab — purplejay` with a `credential` field).
+3. Drop a committable `.env.op` next to your project — references only, no
+   real secrets:
+
+   ```bash
+   # .env.op
+   GL_TOKEN="op://Private/GitLab — purplejay/credential"
+   GL_GITLAB_URL="https://gitlab.purplejay.io"
+   ```
+
+4. Launch your script — or the entire Claude Code session that will use this
+   library — under `op run`:
+
+   ```bash
+   op run --env-file=.env.op -- python my_script.py
+   op run --env-file=.env.op -- claude
+   ```
+
+`op run` resolves the references, exports them to the subprocess, and tears
+them down on exit. Inside Python, just call `config_service.init()` with no
+arguments and the values flow in from the environment.
+
+In CI, skip 1Password and set `GL_TOKEN`/`GL_GITLAB_URL` from the job's
+existing variables (e.g. `CI_JOB_TOKEN` for project-scoped operations).
+
+## Usage
+
+```python
+import asyncio
+from pjdev_gitlab import config_service, issues_service
+from pjdev_gitlab.models import StateEvent
+
+async def main() -> None:
+    # Token & URL come from GL_TOKEN / GL_GITLAB_URL (e.g. via `op run`).
+    config_service.init(default_project_id="my-group/my-project")
+
+    issue = await issues_service.create_issue(
+        project_id="my-group/my-project",
+        title="Bug: timeout on /widgets",
+        description="The endpoint times out under load.\n\n/label ~bug ~priority::high",
+        labels=["bug"],
+    )
+    await issues_service.comment_on_issue(
+        project_id="my-group/my-project",
+        issue_iid=issue.iid,
+        body="Investigating now.",
+    )
+    await issues_service.set_issue_state(
+        project_id="my-group/my-project",
+        issue_iid=issue.iid,
+        state_event=StateEvent.close,
+    )
+
+asyncio.run(main())
+```
+
+Run it: `op run --env-file=.env.op -- python my_script.py`.
+
+## Bundled agent skills
+
+Skill files for AI agents ship under `.agents/skills/` inside the installed package, following the [library-skills.io](https://library-skills.io/create/) convention. Topics: issues, merge requests, repository files, generic packages.
+
+## License
+
+`pjdev-gitlab` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

pjdev_gitlab-5.0.0/pyproject.toml

@@ -0,0 +1,82 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pjdev-gitlab"
+dynamic = ["version"]
+description = ''
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "Purple Jay LLC", email = "developers@purplejay.io" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "httpx",
+  "loguru",
+  "pydantic-settings>=2.13.1",
+  "pydantic>=2.12.5",
+]
+
+[project.optional-dependencies]
+dev = [
+    "ruff",
+]
+
+test = [
+    "pytest",
+    "pytest-asyncio",
+    "respx",
+    "coverage",
+]
+
+[project.urls]
+Documentation = "https://gitlab.purplejay.io/keystone/python/-/tree/main/pjdev-gitlab/README.md"
+Issues = "https://gitlab.purplejay.io/keystone/python/-/issues"
+Source = "https://gitlab.purplejay.io/keystone/python"
+
+[tool.hatch.version]
+path = "src/pjdev_gitlab/__about__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pjdev_gitlab"]
+artifacts = ["src/pjdev_gitlab/.agents/**/*.md", "src/pjdev_gitlab/py.typed"]
+
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/pjdev_gitlab tests}"
+
+[tool.coverage.run]
+source_pkgs = ["pjdev_gitlab", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/pjdev_gitlab/__about__.py",
+]
+
+[tool.coverage.paths]
+pjdev_gitlab = ["src/pjdev_gitlab", "*/pjdev-gitlab/src/pjdev_gitlab"]
+tests = ["tests", "*/pjdev-gitlab/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+python_files = ["tests_for_*.py", "test_*.py"]

pjdev_gitlab-5.0.0/src/pjdev_gitlab/.agents/skills/pjdev_gitlab_issues/SKILL.md

@@ -0,0 +1,150 @@
+---
+name: pjdev_gitlab_issues
+description: Use this skill to automate GitLab issues via pjdev-gitlab — search/analytics, create issues with markdown and inline images, post comments and threaded discussions, and change state, labels, iteration, or milestone. Trigger when the user asks to query, create, or modify GitLab issues programmatically.
+---
+
+# pjdev_gitlab_issues
+
+Async helpers for GitLab issue automation, built on `httpx.AsyncClient` against the [GitLab REST API v4](https://docs.gitlab.com/api/issues/).
+
+Reference docs (source of truth for behavior):
+- [Issues](https://docs.gitlab.com/user/project/issues/)
+- [Comments and threads](https://docs.gitlab.com/user/discussions/)
+- [Labels](https://docs.gitlab.com/user/project/labels/)
+- [Iterations](https://docs.gitlab.com/user/group/iterations/)
+- [Milestones](https://docs.gitlab.com/user/project/milestones/)
+- [Quick actions](https://docs.gitlab.com/user/project/quick_actions/)
+- [GitLab Flavored Markdown](https://docs.gitlab.com/user/markdown/)
+
+## Setup
+
+`pjdev_gitlab` reads `GL_TOKEN` and `GL_GITLAB_URL` from the environment. The
+recommended pattern is to keep the token in 1Password and inject it into the
+host process with [`op run`](https://developer.1password.com/docs/cli/secrets-environment-variables/),
+so the secret never sits in your shell environment or on disk in plaintext.
+
+1. Store the token in 1Password (e.g. an API Credential titled `GitLab — <host>`
+   with a `credential` field).
+2. In the project that uses this skill, create a committable `.env.op` with
+   1Password references — no real secrets:
+
+   ```bash
+   # .env.op
+   GL_TOKEN="op://Private/GitLab — <host>/credential"
+   GL_GITLAB_URL="https://gitlab.example.com"
+   ```
+
+3. Launch the host process (the script, or the entire Claude Code session)
+   under `op run`:
+
+   ```bash
+   op run --env-file=.env.op -- python my_script.py
+   op run --env-file=.env.op -- claude
+   ```
+
+Then call `config_service.init()` with no arguments — it picks up `GL_*` from env:
+
+```python
+from pjdev_gitlab import config_service, issues_service
+
+config_service.init(default_project_id="my-group/my-project")  # token/url from env
+```
+
+For tests or one-off scripts you can still pass values explicitly:
+
+```python
+config_service.init(token="glpat-xxx", gitlab_url="https://gitlab.com")
+```
+
+The token needs `api` scope. Project-scoped tokens work for project-only
+operations; iterations live at group level, so use a group/personal token for
+`list_iterations`.
+
+## Search & analytics
+
+```python
+from pjdev_gitlab import issues_service
+from pjdev_gitlab.models import IssueState
+
+open_bugs = await issues_service.search_issues(
+    "my-group/my-project",
+    state=IssueState.opened,
+    labels=["bug"],
+    created_after="2026-01-01T00:00:00Z",
+)
+
+by_label = await issues_service.aggregate_issues(
+    "my-group/my-project", group_by="label", state=IssueState.opened
+)
+# {"bug": 12, "frontend": 7, ...}
+```
+
+`search_issues` paginates by default. Set `paginate_results=False` for a single page.
+
+## Create with markdown and inline images
+
+`<img src="...">` tags in the description are replaced positionally with the markdown
+returned by GitLab's upload endpoint. Quick actions in the description (e.g. `/label`,
+`/assign`) are processed by GitLab server-side.
+
+```python
+from pathlib import Path
+
+issue = await issues_service.create_issue(
+    "my-group/my-project",
+    title="Bug: timeout on /widgets",
+    description=(
+        "Repro:\n"
+        "1. Open page\n"
+        '2. <img src="placeholder1">\n\n'
+        "/label ~bug ~priority::high\n"
+        "/assign @me"
+    ),
+    image_paths=[Path("./screenshot.png")],
+    labels=["bug"],
+)
+```
+
+## Comment vs. threaded discussion
+
+Single comment:
+
+```python
+await issues_service.comment_on_issue(
+    "my-group/my-project", issue_iid=42, body="Investigating now."
+)
+```
+
+Threaded discussion (use this when subsequent replies should belong to the same thread):
+
+```python
+discussion = await issues_service.start_issue_discussion(
+    "my-group/my-project", issue_iid=42, body="Root-cause analysis"
+)
+```
+
+## Change state, labels, iteration, milestone
+
+```python
+from pjdev_gitlab.models import StateEvent
+
+await issues_service.set_issue_state("my-group/my-project", 42, StateEvent.close)
+await issues_service.set_issue_labels(
+    "my-group/my-project", 42, ["regression"], mode="add"
+)
+await issues_service.set_issue_iteration("my-group/my-project", 42, iteration_id=17)
+await issues_service.set_issue_milestone("my-group/my-project", 42, milestone_id=5)
+```
+
+Iterations and milestones can be discovered with `list_iterations(group_id)` and
+`list_milestones(project_id)`.
+
+## Tips for AI agents
+
+- Prefer quick actions (`/label`, `/assign`, `/iteration *iteration:42`, `/close`)
+  inside the description or comment body instead of multiple API calls — this is
+  one round-trip and matches how humans use GitLab.
+- IIDs (`issue.iid`) are project-scoped and what users see; IDs (`issue.id`) are
+  GitLab-global. Always use IIDs for issue endpoints.
+- Project IDs may be numeric (`12345`) or namespaced paths (`group/sub/project`).
+  Both work; the helpers URL-encode them automatically.