irusdk 0.1.0__tar.gz

irusdk-0.1.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @liquidz00

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

@@ -0,0 +1,147 @@
+name: Bug report
+description: Report a defect in irusdk
+title: "[BUG] "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to file a bug report. The more details you can provide, the faster the fix.
+
+  - type: dropdown
+    id: surface
+    attributes:
+      label: How are you using irusdk?
+      options:
+        - Python library
+        - CLI (`irusdk`)
+        - Both
+    validations:
+      required: true
+
+  - type: dropdown
+    id: client
+    attributes:
+      label: Which client?
+      description: The CLI drives the synchronous client, so pick that if you're unsure.
+      options:
+        - Synchronous (`IruClient`)
+        - Asynchronous (`AsyncIruClient`)
+        - Both
+        - Not applicable
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the issue
+      description: What is not working as expected?
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to reproduce
+      description: |
+        The smallest snippet or command that triggers the problem. Replace your tenant and token with placeholders.
+      render: python
+      placeholder: |
+        from irusdk import IruClient
+
+        client = IruClient(subdomain="mycompany", token="...")
+
+        for device in client.devices.list(platform="Mac"):
+            print(device.device_name)
+
+        # Or, for a CLI issue:
+        # irusdk devices list --platform Mac
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual behavior / error message
+      description: |
+        What happened instead? Please copy and paste the exact error message or full traceback.
+      render: text
+      placeholder: |
+        irusdk._core.errors.AuthenticationError: Authentication failed (status_code: 403 | url: https://mycompany.api.kandji.io/api/v1/devices | detail: You do not have permission to perform this action.)
+    validations:
+      required: true
+
+  - type: input
+    id: irusdk-version
+    attributes:
+      label: irusdk version
+      description: 'Output of `python -c "import irusdk; print(irusdk.__version__)"`, or `irusdk --version`'
+      placeholder: "0.1.0"
+    validations:
+      required: true
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python version
+      description: 'Output of `python --version`'
+      placeholder: "3.13.2"
+    validations:
+      required: true
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      description: Where the code is running — your Mac, a CI runner, a container.
+      placeholder: "macOS 26.4.1 / ubuntu-latest / python:3.13-slim"
+    validations:
+      required: false
+
+  - type: dropdown
+    id: region
+    attributes:
+      label: Tenant region
+      description: Only relevant if the issue involves connecting to your tenant at all.
+      options:
+        - US
+        - EU
+        - Not sure / not relevant
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: |
+        ### Logs
+
+        `irusdk` logs to the `irusdk` logger; enable `DEBUG` to capture retries and request details:
+
+        ```python
+        import logging
+        logging.basicConfig(level=logging.DEBUG)
+        ```
+
+        **Debug output can contain sensitive information** — your API token, tenant subdomain, device
+        serial numbers, and user email addresses. Please review and redact before sharing publicly.
+
+        - **Preferred (private)**: DM the maintainer in the [MacAdmins Slack](https://macadmins.slack.com/team/U04EC7ZN4SJ).
+        - **Public**: paste below, but only after removing sensitive data.
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs (optional, public)
+      description: Paste here only if you're comfortable. Redact your token, tenant, serials, and emails first.
+      render: text
+    validations:
+      required: false

irusdk-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Documentation
+    url: https://irusdk.readthedocs.io/en/latest
+    about: Browse the user guide and API reference before opening an issue.
+  - name: Managing library content (Custom Apps, Scripts, Profiles)
+    url: https://github.com/kandji-inc/iructl
+    about: irusdk does not author library content by design. Use iructl, Iru's own tool, for that.
+  - name: MacAdmins Slack
+    url: https://macadmins.slack.com
+    about: For questions and general discussion rather than a specific defect or request.

irusdk-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,79 @@
+name: Feature request
+description: Suggest an idea for irusdk
+title: "[FEATURE] "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for the suggestion! The more context you provide, the better.
+
+        **Before you file:** `irusdk` covers the *fleet* surface of the Iru API — devices, blueprints,
+        users, and tags. It deliberately does not author library content (Custom Apps, Scripts,
+        Profiles, In-House Apps); Iru's own [`iructl`](https://github.com/kandji-inc/iructl) does that
+        job well. See [Scope](https://irusdk.readthedocs.io/en/latest/guide/scope.html).
+
+  - type: dropdown
+    id: area
+    attributes:
+      label: What area does this touch?
+      options:
+        - Devices
+        - Blueprints
+        - Users or tags
+        - An unwrapped endpoint (Prism, vulnerabilities, threats, audit events, ADE)
+        - Core (pagination, retries, rate limiting, errors, models)
+        - CLI
+        - Documentation
+        - Something else
+    validations:
+      required: true
+
+  - type: textarea
+    id: current-behavior
+    attributes:
+      label: Current behavior
+      description: |
+        Briefly describe how irusdk currently behaves, or what is missing, that prompted this request.
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposed-change
+    attributes:
+      label: Proposed change
+      description: A description of the feature or improvement you are suggesting. Focus on what you'd like to see happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: |
+        Anything that would help others understand your proposal — a link to the relevant
+        [Iru API documentation](https://api-docs.iru.com), an example response payload, or the
+        workflow you are trying to automate.
+    validations:
+      required: false
+
+  - type: textarea
+    id: sample-code
+    attributes:
+      label: Sample code (optional)
+      description: How you would like the API to look. Pseudo-code is fine.
+      render: python
+      placeholder: |
+        for detection in client.vulnerabilities.detections(severity="critical"):
+            print(detection.cve_id, detection.device_name)
+    validations:
+      required: false
+
+  - type: input
+    id: related-issues
+    attributes:
+      label: Related issues (optional)
+      description: Link to any existing or previously closed issues related to this request.
+      placeholder: "#123, #456"
+    validations:
+      required: false

irusdk-0.1.0/.github/ISSUE_TEMPLATE/feedback.yml

@@ -0,0 +1,42 @@
+name: Feedback
+description: Share your thoughts about irusdk
+title: "[FEEDBACK] "
+labels: ["feedback"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for sharing! All feedback is welcome — what's working, what's not, what's confusing.
+
+        Thoughts on the API surface, naming, or documentation are especially useful while the SDK is
+        pre-1.0 and things can still change without breaking anyone.
+
+  - type: dropdown
+    id: area
+    attributes:
+      label: What is this about?
+      options:
+        - The Python API (naming, ergonomics, typing)
+        - Documentation
+        - The CLI
+        - Scope — what the SDK does and does not cover
+        - General impressions
+        - Something else
+    validations:
+      required: true
+
+  - type: textarea
+    id: feedback
+    attributes:
+      label: Your feedback
+      description: A clear and concise description of your feedback.
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Any other context, code snippets, or screenshots related to your feedback.
+    validations:
+      required: false

irusdk-0.1.0/.github/dependabot.yml

@@ -0,0 +1,21 @@
+version: 2
+updates:
+
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    groups:
+      github-actions:
+        patterns: ["*"]
+
+  # Python (uv-managed). Groups all updates into a single weekly PR
+  # to avoid noise — security alerts still fire individually as needed.
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      python-deps:
+        patterns: ["*"]

irusdk-0.1.0/.github/workflows/build-release-publish.yml

@@ -0,0 +1,107 @@
+name: Build, Release and Publish
+
+on:
+  workflow_dispatch:
+    inputs:
+      contributors:
+        description: "Contributors for this release"
+        required: false
+        default: ''
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  build-and-release:
+    name: Build, Release, and Publish to PyPi
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Sync dependencies
+        run: uv sync --extra dev
+
+      - name: Read release version
+        id: version
+        run: |
+          VERSION=$(uv run python -c 'from irusdk.__about__ import __version__; print(__version__)')
+          echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
+          echo "Building version: ${VERSION}"
+
+      - name: Check if tag exists
+        env:
+          VERSION: ${{ steps.version.outputs.version }}
+        run: |
+          # Anchored so v0.1.1 doesn't match an existing v0.1.10.
+          if git ls-remote --tags origin | grep -qE "refs/tags/v${VERSION}$"; then
+            echo "Tag v${VERSION} already exists!"
+            exit 1
+          fi
+
+      - name: Build distribution packages
+        run: make build
+
+      - name: Store distribution package
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
+        with:
+          name: irusdk-${{ steps.version.outputs.version }}
+          path: dist/
+
+      - name: Publish package to PyPI
+        id: publish_pypi
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33  # v1.14.2
+
+      - name: Get Changelog updates
+        id: changelog_reader
+        uses: mindsers/changelog-reader-action@1faaf50aa09d5793d9a100819973df801febfb31  # v2.4.0
+        with:
+          validation_depth: 100
+          version: v${{ steps.version.outputs.version }}
+
+      - name: Generate changelog
+        id: changelog
+        uses: metcalfc/changelog-generator@98b12822c5dc6bad335d1d60d920cb69831b9c5d  # v4.8.0
+        continue-on-error: true  # don't block releases
+        with:
+          myToken: ${{ secrets.GITHUB_TOKEN }}
+          reverse: 'true'
+
+      - name: Create Release
+        id: create_release
+        if: ${{ steps.publish_pypi.outcome == 'success' }}
+        uses: softprops/action-gh-release@3d0d9888cb7fd7b750713d6e236d1fcb99157228  # v3.0.2
+        with:
+          name: irusdk ${{ steps.version.outputs.version }}
+          tag_name: v${{ steps.version.outputs.version }}
+          draft: false
+          prerelease: false
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: |
+            ./dist/*.tar.gz
+            ./dist/*.whl
+          body: |
+            # Release Notes
+            This release has been automatically generated by a GitHub Action.
+            For detailed installation instructions, please refer to the [README](https://github.com/liquidz00/irusdk/blob/main/README.md).
+
+            ## Changelog for this release
+            This amended changelog is specific to this release. View the [full changelog](https://github.com/liquidz00/irusdk/blob/main/CHANGELOG.md) for all details.
+            ${{ steps.changelog_reader.outputs.changes }}
+
+            ## Changes
+            ${{ steps.changelog.outputs.changelog }}
+
+            ### Contributors
+            ${{ github.event.inputs.contributors }}

irusdk-0.1.0/.github/workflows/run-tests.yml

@@ -0,0 +1,42 @@
+name: Run Tests
+
+on: [push, pull_request]
+
+permissions: read-all
+
+jobs:
+  run-tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+    name: Run unit tests
+    runs-on: ${{ matrix.os }}
+    env:
+      UV_PYTHON: ${{ matrix.python-version }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python with uv
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: make install-dev
+
+      - name: Lint and format
+        run: make lint
+
+      - name: Run tests
+        run: make test-cov

irusdk-0.1.0/.gitignore

@@ -0,0 +1,163 @@
+# 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/
+coverage/
+
+# Translations
+*.mo
+*.pot
+
+# 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
+
+# ruff
+.ruff_cache/
+
+# 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/
+
+# macOS
+*.DS_Store
+
+# VSCode
+.vscode/
+
+# Project specific
+spec/

irusdk-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,76 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+default_language_version:
+  python: python3
+
+repos:
+  # General file fixes and checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      # File hygiene
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [--fix=lf]
+
+      # File format validation
+      - id: check-yaml
+        args: [--unsafe]  # Allow custom tags
+      - id: check-toml
+
+      # Python specific checks
+      - id: check-ast
+      - id: check-docstring-first
+      - id: debug-statements
+      - id: check-builtin-literals
+
+      # Security
+      - id: detect-private-key
+
+      # General checks
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-added-large-files
+        args: [--maxkb=500]
+
+  # Python linting and formatting with ruff
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.3
+    hooks:
+      # Run the linter
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      # Run the formatter
+      - id: ruff-format
+
+  # Validate GitHub Actions workflows
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.12
+    hooks:
+      - id: actionlint
+
+  # Validate pyproject.toml
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.24.1
+    hooks:
+      - id: validate-pyproject
+
+# Configuration to skip certain paths
+exclude: |
+  (?x)^(
+    \.git/|
+    \.venv/|
+    venv/|
+    __pycache__/|
+    \.pytest_cache/|
+    \.ruff_cache/|
+    \.mypy_cache/|
+    build/|
+    dist/|
+    .*\.egg-info/|
+    htmlcov/|
+    coverage/|
+    \.coverage
+  )$

irusdk-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14