jirapi 0.1.0__tar.gz

jirapi-0.1.0/.claude/settings.json

@@ -0,0 +1,46 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(uv run ruff:*)",
+      "Bash(uv run pytest:*)",
+      "Bash(uv sync:*)",
+      "Bash(uv run:*)",
+      "Bash(uv lock:*)",
+      "Bash(uv build:*)",
+      "Bash(tree:*)",
+      "Bash(ls:*)",
+      "Bash(find:*)",
+      "Bash(head:*)",
+      "Bash(tail:*)",
+      "Bash(grep:*)",
+      "Bash(gh pr view:*)",
+      "Bash(gh pr checks:*)",
+      "Bash(gh pr diff:*)",
+      "Bash(gh pr list:*)",
+      "Bash(python3:*)",
+      "Bash(gh api:*)",
+      "Bash(task:*)"
+    ],
+    "deny": [
+      "Bash(curl *)",
+      "Bash(ssh *)",
+      "Read(./.env)",
+      "Read(./.env.*)",
+      "Read(./secrets/**)"
+    ],
+    "additionalDirectories": [
+      "/tmp"
+    ]
+  },
+  "enabledPlugins": {
+    "security-guidance@claude-plugins-official": true,
+    "pr-review-toolkit@claude-plugins-official": true,
+    "github@claude-plugins-official": true,
+    "context7@claude-plugins-official": true,
+    "claude-md-management@claude-plugins-official": true,
+    "code-review@claude-plugins-official": true,
+    "claude-code-setup@claude-plugins-official": true,
+    "code-simplifier@claude-plugins-official": true,
+    "feature-dev@claude-plugins-official": true
+  }
+}

jirapi-0.1.0/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [brett-fitz]

jirapi-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,75 @@
+name: Bug Report
+description: Report a bug in jirapi
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug. Please fill out the sections below.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of the bug.
+      placeholder: Describe the bug...
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Create a client with ...
+        2. Call ...
+        3. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: What you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual behavior
+      description: What actually happened. Include tracebacks if applicable.
+    validations:
+      required: true
+
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: Python version
+      options:
+        - "3.11"
+        - "3.12"
+        - "3.13"
+        - "3.14"
+    validations:
+      required: true
+
+  - type: input
+    id: jirapi-version
+    attributes:
+      label: jirapi version
+      description: "Output of: python -c \"import jirapi; print(jirapi.__version__)\""
+      placeholder: "0.1.0"
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Any other context, logs, or screenshots.
+    validations:
+      required: false

jirapi-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,24 @@
+# Pull Request
+
+## What
+
+<!-- Brief description of the change -->
+
+## Why
+
+<!-- Motivation or context for the change -->
+
+## Type
+
+- [ ] Feature
+- [ ] Bug fix
+- [ ] Refactor
+- [ ] Documentation
+- [ ] CI / CD
+- [ ] Other
+
+## Checklist
+
+- [ ] Tests added or updated
+- [ ] `task check` passes (lint + format + tests)
+- [ ] Documentation updated (if applicable)

jirapi-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,128 @@
+name: ci / lint, test and publish
+
+on:
+  workflow_dispatch:
+
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**.py'
+      - 'pyproject.toml'
+      - 'uv.lock'
+      - 'Taskfile.yml'
+
+  release:
+    types: [published]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+
+  lint:
+    name: ruff
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v6
+
+      - name: Install go-task
+        uses: go-task/setup-task@v1
+        with:
+          version: 3.x
+
+      - name: Set up UV
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: task setup
+
+      - name: Run Ruff Check
+        run: task lint
+
+      - name: Run Ruff Format Check
+        run: task format:check
+
+  test:
+    name: tests (python ${{ matrix.python }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.11", "3.12", "3.13", "3.14"]
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v6
+
+      - name: Install go-task
+        uses: go-task/setup-task@v1
+        with:
+          version: 3.x
+
+      - name: Set up UV
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python }}
+
+      - name: Install dependencies
+        run: task setup
+
+      - name: Verify lockfile
+        run: task lock:check
+
+      - name: Run pytest with coverage
+        run: task test:ci
+
+      - name: Generate coverage reports
+        run: |
+          uv run coverage json
+          uv run coverage report
+
+      - name: Coverage comment
+        if: ${{ matrix.python == '3.14' && github.event_name == 'pull_request' }}
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ github.token }}
+          MINIMUM_GREEN: 70
+          MINIMUM_ORANGE: 50
+
+      - name: Optimize UV cache
+        run: uv cache prune --ci
+
+  publish:
+    name: publish to PyPI
+    needs: [lint, test]
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/jirapi
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v6
+
+      - name: Set up UV
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

jirapi-0.1.0/.github/workflows/claude-code.yml

@@ -0,0 +1,54 @@
+name: claude / code
+
+on:
+  pull_request_review_comment:
+    types: [created]
+  pull_request_review:
+    types: [submitted]
+
+jobs:
+  claude:
+    if: |
+      (
+        (github.event_name == 'pull_request_review_comment' && github.event.comment.user.login == 'brett-fitz' && contains(github.event.comment.body, '@claude')) ||
+        (github.event_name == 'pull_request_review' && github.event.review.user.login == 'brett-fitz' && contains(github.event.review.body, '@claude'))
+      )
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: read
+      id-token: write
+      actions: read
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 1
+
+      - name: Set up UV
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Run Claude Code
+        id: claude
+        uses: anthropics/claude-code-action@v1
+        with:
+          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+          use_commit_signing: true
+
+          additional_permissions: |
+            actions: read
+
+          claude_args: |
+            --model "claude-sonnet-4-6"
+            --allowed-tools "Bash(gh issue:*),Bash(gh search:*),Bash(gh pr view:*),Bash(gh pr comment:*),Bash(gh pr list:*),Bash(gh pr create:*),Bash(gh pr update:*)"
+
+          track_progress: true
+
+      - name: Optimize UV cache
+        run: uv cache prune --ci

jirapi-0.1.0/.github/workflows/claude-issue-code.yml

@@ -0,0 +1,83 @@
+name: claude / issue / code
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  claude:
+    if: |
+      github.event.comment.user.login == 'brett-fitz' &&
+      contains(github.event.comment.body, '@claude')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: read
+      id-token: write
+      actions: read
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 1
+
+      - name: Set up UV
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Run Claude Code
+        id: claude
+        uses: anthropics/claude-code-action@v1
+        with:
+          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+          use_commit_signing: true
+
+          additional_permissions: |
+            actions: read
+
+          prompt: |
+            <task>
+              <instructions>
+                Review the issue context and user request first. Only complete the user request if you can.
+                If you believe the task is too difficult or needs to be broken up, then suggest this.
+                If you need to know more about the issue, then ask the user for more information.
+                If you create a pull request, provide the issue number in the pull request title.
+                e.g. "[#123] Add feature".
+                If you create a pull request, be sure to follow .github/pull_request_template.md for
+                the pull request template.
+                If you make changes to the code, ensure proper pytest coverage is maintained.
+                If you make changes to the code, be sure to run the pytests tests and ensure they pass.
+                If you make changes to the code, be sure to run the ruff linting, formatting and ensure it passes.
+              </instructions>
+
+              <issue_context>
+                REPO: ${{ github.repository }}
+                ISSUE NUMBER: ${{ github.event.issue.number }}
+                TITLE: ${{ github.event.issue.title }}
+                BODY:
+                  ${{ github.event.issue.body }}
+                AUTHOR: ${{ github.event.issue.user.login }}
+                COMMENT AUTHOR: ${{ github.event.comment.user.login }}
+              </issue_context>
+
+              <user_request>
+                COMMENT: ${{ github.event.comment.body }}
+
+                Note: If the comment above only contains "@claude" with no other meaningful instructions,
+                treat this as a request to "Resolve the issue" based on the issue context provided.
+              </user_request>
+            </task>
+
+          claude_args: |
+            --model "claude-opus-4-6"
+            --allowed-tools "Bash(gh issue:*),Bash(gh search:*),Bash(gh pr view:*),Bash(gh pr comment:*),Bash(gh pr list:*),Bash(gh pr create:*),Bash(gh pr update:*)"
+
+          track_progress: true
+
+      - name: Optimize UV cache
+        run: uv cache prune --ci

jirapi-0.1.0/.github/workflows/claude-issue-triage.yml

@@ -0,0 +1,53 @@
+name: claude / issue / triage
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  triage:
+    if: github.event.issue.user.login == 'brett-fitz'
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      contents: read
+      pull-requests: read
+      id-token: write
+      actions: read
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v6
+
+      - uses: anthropics/claude-code-action@v1
+        with:
+          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+          prompt: |
+            REPO: ${{ github.repository }}
+            ISSUE NUMBER: ${{ github.event.issue.number }}
+            TITLE: ${{ github.event.issue.title }}
+            BODY: ${{ github.event.issue.body }}
+            AUTHOR: ${{ github.event.issue.user.login }}
+
+            Analyze this new issue and perform the following steps:
+            1. Determine if it's a bug report, feature request, or question
+            2. Assess priority (critical, high, medium, low)
+            3. Suggest appropriate labels
+            4. Check if it duplicates existing issues
+            5. Check if it is related to existing issues
+            6. Check if it is dependent on other opened issues
+            7. If it is a bug, triage it but do not resolve it.
+            8. If it is a feature request, do NOT suggest a solution or resolve it.
+
+            Based on your analysis, add the appropriate labels using:
+            `gh issue edit [number] --add-label "label1,label2"`
+
+            Finally when you are done, post a comment on the issue with the following information:
+            - A concise summary of your triage and steps taken.
+            - If it appears to be a duplicate, mention the original issue.
+            - If the issue relates to another issue, then add a comment "Relates to #<issue number>".
+            - If the issue is dependent on another issue, then add a comment "Depends on #<issue number>".
+
+            REMEMBER: Your job is to triage the issue, not to resolve it.
+          claude_args: |
+            --model "claude-sonnet-4-6"
+            --allowedTools "Bash(gh issue:*),Bash(gh search:*),Bash(gh pr view:*),Bash(gh pr comment:*),Bash(gh pr list:*)"

jirapi-0.1.0/.github/workflows/claude-pull_request-code_review.yml

@@ -0,0 +1,37 @@
+name: claude / pull request / code review
+
+on:
+  pull_request:
+    types: [opened, synchronize, ready_for_review, reopened]
+
+jobs:
+  claude-review:
+    if: |
+      github.event.pull_request.user.login == 'brett-fitz' ||
+      github.event.pull_request.user.login == 'dependabot[bot]' ||
+      github.event.pull_request.user.login == 'renovate[bot]'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: read
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 1
+
+      - name: Run Claude Code Review
+        id: claude-review
+        uses: anthropics/claude-code-action@v1
+        with:
+          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+          plugin_marketplaces: 'https://github.com/anthropics/claude-code.git'
+          plugins: 'code-review@claude-code-plugins'
+          prompt: '/code-review:code-review ${{ github.repository }}/pull/${{ github.event.pull_request.number }}'
+          track_progress: true
+          allowed_bots: "dependabot[bot],renovate[bot],claude[bot],cursor[bot],copilot[bot]"
+          claude_args: |
+            --model "claude-opus-4-6"

jirapi-0.1.0/.gitignore

@@ -0,0 +1,32 @@
+# Mac
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Environments
+.idea/
+.venv/
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Testing & Coverage
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+.pytest_cache/
+
+# ruff
+.ruff_cache/
+
+# Secrets
+.env
+.env.*
+secrets/

jirapi-0.1.0/AGENTS.md

@@ -0,0 +1,149 @@
+# AGENTS.md
+
+This file provides guidance to AI coding agents when working with code in this repository.
+
+## Project Overview
+
+`jirapi` is a modern, type-safe Python client for the Jira Cloud REST API, built on [HTTPX](https://www.python-httpx.org/) for first-class sync and async support.
+
+**Technology Stack:**
+- Python 3.11+ with UV for dependency management
+- [Taskfile](https://taskfile.dev/) (go-task) for task running (`Taskfile.yml`)
+- Ruff for linting and formatting
+- pytest for testing with pytest-cov for coverage
+- HTTPX for HTTP transport (sync + async)
+- Pydantic for data models and validation
+
+## Common Development Commands
+
+### Setup and Installation
+```bash
+task setup                  # uv sync --all-groups
+uv run python -c "import jirapi; print('OK')"
+```
+
+### Testing
+```bash
+task test                   # uv run pytest tests/unit
+task test:cov               # uv run pytest --cov=jirapi tests/unit
+uv run pytest tests/unit/test_specific.py  # single file
+task test:integration       # requires live Jira API access
+```
+
+### Code Quality
+```bash
+task format                 # uv run ruff format .
+task lint                   # uv run ruff check .
+task lint:fix               # uv run ruff check . --fix
+task check                  # lint + format check + tests
+task lock:check             # verify lockfile is up-to-date
+```
+
+### Code Generation
+```bash
+task generate:models        # generate Pydantic models from OpenAPI spec
+task generate:resources     # generate resource classes from OpenAPI spec
+task generate               # run all generators (models + resources)
+```
+
+### Building
+```bash
+task build                  # uv build
+```
+
+## Architecture and Code Organization
+
+```
+jirapi/                     # Python package (the library)
+├── __init__.py             # Public API exports
+├── client.py               # Jira (sync + async)
+├── models/                 # Pydantic request/response models
+├── exceptions.py           # Custom exception hierarchy
+└── py.typed                # PEP 561 marker
+
+scripts/                    # Code generation scripts
+├── generate_models.py      # Pydantic model generator (OpenAPI → models/)
+└── generate_resources.py   # Resource class generator (OpenAPI → resources/)
+
+tests/                      # Test suites
+├── unit/                   # Unit tests (pytest default)
+│   └── conftest.py         # Shared fixtures
+└── integration/            # Integration tests (live API)
+
+docs/                       # Documentation
+```
+
+## Code Style and Standards
+
+### Python Style
+
+**Imports:**
+- Use absolute imports over relative imports
+- Order imports alphabetically (isort via ruff)
+
+**Type Hints:**
+- Use type hints for all function parameters and returns
+- Prefer built-in generics (`list[str]`, `dict[str, int]`) over `typing` equivalents
+- Use union syntax (`str | None`) instead of `Optional[str]`
+- Do not import deprecated typing names (`Dict`, `List`, `Set`, `Tuple`, `Optional`)
+
+**Naming Conventions:**
+- snake_case for functions and variables
+- PascalCase for classes
+- UPPER_CASE for constants
+- Maximum line length: 100 characters
+
+**Docstrings:**
+- Use Google-style docstrings (configured in ruff)
+- Document all public APIs
+- Focus on why, not what
+- Every module must have a module-level docstring
+
+**Other Rules:**
+- `__init__.py` files must define `__all__` to declare the public API
+- Always specify exception types — never use bare `except:` or `except Exception:` without good reason
+- Prefer `async def` for all I/O-bound operations
+- Constants over magic numbers
+- Single responsibility per function
+
+### Testing Requirements
+
+- Write tests before fixing bugs
+- Test edge cases and error scenarios
+- Use pytest for all testing
+- Use proper mocking with pytest-mock and respx (for HTTPX)
+- Use fixtures for test setup
+- Mark integration tests with `@pytest.mark.integration`
+- **MUST run `task format && task lint` before completion**
+
+### Security
+
+- Never commit credentials or sensitive information
+- Never hardcode API tokens — accept them as parameters
+- Sanitize all user inputs
+
+### Version Control
+
+- Feature branches: `feature/<description>`
+- Bugfix branches: `fix/<description>`
+- Small, focused commits with clear messages
+- Follow semantic versioning (MAJOR.MINOR.PATCH)
+- **MUST run `task format && task lint` before considering work complete**
+
+### Changelog
+
+- **MUST update `CHANGELOG.md`** when making user-facing changes
+- Add a new version section (e.g. `## [0.2.0] - YYYY-MM-DD`) or append to the latest unreleased section at the top
+- Use the appropriate subsection: `Added`, `Changed`, `Fixed`, `Removed`
+- Follow [Keep a Changelog](https://keepachangelog.com/) format
+- Do not modify entries for already-released versions
+
+### Development Workflow
+
+1. Create feature branch
+2. Make changes following coding standards
+3. Run quality checks: `task format && task lint`
+4. Run tests: `task test:cov`
+5. Verify lockfile: `task lock:check`
+6. Update `CHANGELOG.md`
+7. Submit PR using the PR template