zabbix-cli-uio 3.1.1__tar.gz

zabbix_cli_uio-3.1.1/.github/workflows/build.yml

@@ -0,0 +1,122 @@
+name: build zabbix-cli
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+**'
+
+concurrency:
+  group: build-zabbix-cli-${{ github.head_ref }}
+
+jobs:
+  build_pypi:
+    name: Build wheels and source distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+
+      - name: Install build dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Build source distribution
+        run: uv run python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: pypi_artifacts
+          path: dist/*
+          if-no-files-found: error
+
+  build_pyinstaller:
+    name: Build pyinstaller binary
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version:
+          - '3.12'
+        include:
+          - os: ubuntu-latest
+            container: centos:8
+    runs-on: ${{ matrix.os }}
+    container: ${{ matrix.container }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+
+      - name: Install build dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Build binary with PyInstaller
+        run: uv run pyinstaller --onefile zabbix_cli/main.py --name zabbix-cli
+
+      - name: Rename binary
+        run: |
+          mv dist/zabbix-cli${{ contains(matrix.os, 'windows') && '.exe' || '' }} dist/zabbix-cli-${{ matrix.os }}-${{ matrix.python-version }}${{ contains(matrix.os, 'windows') && '.exe' || '' }}
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: zabbix-cli-${{ matrix.os }}-${{ matrix.python-version }}${{ contains(matrix.os, 'windows') && '.exe' || '' }}
+          path: dist/zabbix-cli-${{ matrix.os }}-${{ matrix.python-version }}${{ contains(matrix.os, 'windows') && '.exe' || '' }}
+          if-no-files-found: error
+
+  publish_pypi:
+    name: Publish PyPI release
+    needs:
+      - build_pypi
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: pypi_artifacts
+          path: dist
+
+      - name: Push build artifacts to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.8.14
+
+  publish_github:
+    name: Publish GitHub release
+    needs:
+      - build_pypi
+      - build_pyinstaller
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download PyInstaller binaries
+        uses: actions/download-artifact@v4
+        with:
+          pattern: zabbix-cli-*
+          path: dist
+          merge-multiple: true
+
+      - name: Download wheel and source distributions
+        uses: actions/download-artifact@v4
+        with:
+          pattern: pypi_artifacts
+          path: dist
+          merge-multiple: true
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          body: |
+            Release notes for ${{ github.ref_name }}
+          draft: false
+          prerelease: false

zabbix_cli_uio-3.1.1/.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+name: build-docs
+
+on:
+  push:
+    branches:
+      - master
+      - docs-dev
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/docs.yml"
+      - "pyproject.toml"
+      - "zabbix_cli/**"
+
+concurrency:
+  group: docs-deploy
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+
+      - name: Install hatch
+        run: |
+          uv pip install --system hatch
+
+      - name: Build documentation and publish
+        run: hatch run docs:mkdocs gh-deploy --force

zabbix_cli_uio-3.1.1/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+      - 'debian/**'
+      - 'rpm/**'
+      - 'README.md'
+
+  pull_request:
+
+name: CI
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - '3.8'
+          - '3.9'
+          - '3.10'
+          - '3.11'
+          - '3.12'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+      - name: Install dependencies
+        run: |
+          uv sync --all-extras --dev
+      - name: Test
+        run: uv run pytest -vv tests

zabbix_cli_uio-3.1.1/.gitignore

@@ -0,0 +1,30 @@
+*.pyc
+
+# Build files
+dist/
+build/
+*.egg-info/
+
+.coverage
+
+.venv/
+venv/
+
+.dccache
+.vscode/launch.json
+my_tests/
+
+# Hatch Pyapp
+pyapp
+
+# Dev commands and directories
+zabbix_cli/commands/_dev.py
+dev/
+
+# Auto-generated docs files
+docs/guide/commands/
+docs/data
+site/
+
+# Pyinstaller
+*.spec

zabbix_cli_uio-3.1.1/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.17.0
+    hooks:
+      - id: pyupgrade
+        args: [--py37-plus, --keep-runtime-typing]
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.6.2"
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.377
+    hooks:
+    - id: pyright
+      exclude: ^(tests|scripts|docs)/

zabbix_cli_uio-3.1.1/AUTHORS

@@ -0,0 +1,32 @@
+# Based on `git shortlog --all -es` with duplicates removed
+
+Alexandru Tică
+Andreas Dobloug
+Boris Manojlovic
+Carl Morten Boger
+Emanuele Borin
+Fabian Arrotin
+Fabian Stelzer
+Florian Tham
+Fredrik Larsen
+Ganesh Hegde
+Herdir
+Jarle Bjørgeengen
+Jean-Baptiste Denis
+Jelmer Vernooij
+Kim Rioux-Paradis
+Logan V
+Marius Bakke
+Mathieu Marleix
+Michael Gindonis
+Mustafa Ocak
+Mélissa Bertin
+Paal Braathen
+Peder Hovdan Andresen
+Peet Whittaker
+Petter Reinholdtsen
+Rafael Martinez Guerrero
+Retyunskikh Dmitriy
+Steve McDuff
+Terje Kvernes
+Volker Fröhlich

zabbix_cli_uio-3.1.1/CHANGELOG

@@ -0,0 +1,271 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!-- released start -->
+
+<!-- ## [Unreleased] -->
+
+## 3.1.1
+
+### Added
+
+- Publish to PyPI.
+
+## 3.1.0
+
+### Added
+
+- Plugin support. See the [plugins documentation](https://unioslo.github.io/zabbix-cli/plugins/) for more information.
+
+### Changed
+
+- `--config` now always creates the config file at the given location if it doesn't exist.
+- `show_config` now shows the absolute path to the active configuration file.
+
+## 3.0.3
+
+### Added
+
+- `--limit` option for `show_*` commands to limit the number of results shown:
+  - `show_usermacro_host_list`
+  - `show_usermacro_template_list`
+  - `show_maintenance_periods`
+
+### Changed
+
+- `show_host_usermacros` rendering of `automatic` field.
+  - Now shows a human readable string instead of `0` or `1`.
+- Example formatting.
+- Hide defaults for required positional arguments.
+- `show_dirs` and `init` no longer requires logging in to the Zabbix API or an existing configuration file.
+- Log record format:
+  - No longer includes the process ID.
+  - Now includes filename, line number and function name.
+- Rich markup is no longer included in log messages.
+- Accessing the config when it is not loaded now uses the same sample config as `sample_config` instead of raising an exception.
+
+### Fixed
+
+- `show_usermacro_host_list` not showing all hosts with the given macro.
+- `show_usermacro_template_list` not showing all templates with the given macro.
+- Auth token file using username from config file instead of from prompt.
+
+## 3.0.2
+
+### Added
+
+- `show_hosts`: `--hostgroup` option for filtering by host group names or IDs.
+- `show_last_values`: ` Item ID filtering.
+- `show_usergroup`: Group ID filtering.
+- `show_usergroups`: Group name or ID filtering.
+- `show_users`: `--sort` option for sorting results by a field.
+- Status messages when fetching data from the Zabbix API in most `show_*` commands.
+- `--limit` option for most `show_*` commands to limit the number of results shown.
+- Environment variable `ZABBIX_API_TOKEN` for logging in with an API token.
+
+### Fixed
+
+- Markup errors when rendering Zabbix items with keys containing special characters.
+- Environment variables not matching V2 names.
+  - Before: `ZABBIX_CLI_USERNAME`, `ZABBIX_CLI_PASSWORD`
+  - After: `ZABBIX_USERNAME`, `ZABBIX_PASSWORD`
+
+## 3.0.1
+
+### Changed
+
+- `migrate_config` no longer requires logging in to the Zabbix API.
+
+### Fixed
+
+- `migrate_config` not migrating username to the new `api.username` field in the resulting TOML configuration file.
+- `migrate_config` using `legacy_json_format = true` in the resulting TOML configuration file by default.
+  - Can force the old JSON format with the new `--legacy-json-format` flag.
+
+## 3.0.0
+
+### Added
+
+- New CLI powered by `typer` and `click-repl`
+- Shell autocompletion
+- TOML configuration file support
+  - Old configuration format is deprecated.
+- Usage examples for most commands.
+- **New configuration options:**
+  - `app.default_format`: Sets the default CLI output format. Defaults to `table`.
+  - `app.legacy_json_format`: Enables the old JSON output format. Defaults to `false`.
+- **New commands:**
+  - `add_proxy_to_group`: Add a proxy to a proxy group.
+  - `create_templategroup`: Create a template group.
+  - `extend_hostgroup`: Add all hosts from a host group to other host group(s) without removing them from the original group.
+  - `extend_templategroup`: Add all templates from a group to other group(s) without removing them from the original group.
+  - `init`: Initialize the CLI configuration file.
+  - `link_template_to_template`: Link template(s) to template(s).
+  - `move_hosts`: Move all hosts from one host group to another.
+  - `move_templates`: Move all templates from one group to another.
+  - `open`: Open a CLI directory in the system's file manager.
+  - `remove_hostgroup`: Delete a host group.
+  - `remove_host_interface`: Delete a host interface.
+  - `remove_proxy_from_group`: Remove a proxy from a proxy group.
+  - `remove_templategroup`: Delete a template group.
+  - `show_dirs`: Show directories used by the CLI.
+  - `show_host_interfaces`: Show interfaces for a host.
+  - `show_media_types`: Show media types.
+  - `show_proxies`: Show proxies.
+  - `show_proxy_groups`: Show proxy groups.
+  - `show_proxy_group_hosts`: Show hosts in a proxy group.
+  - `show_templategroup`: Show a single template group.
+  - `show_templategroups`: Show all template groups.
+  - `show_user`: Show details for a single user.
+  - `unlink_template_from_template`: Unlink template(s) from template(s).
+  - `update_host_interface`: Update a host interface.
+  - `update_user`: Update a user.
+  - `update_hostgroup_proxy`: Assign a proxy to all hosts in one or more host groups.
+  - `update_hostgroup_proxygroup`: Assign a proxy group to all hosts in one or more host groups.
+- **New command options:**
+  - `add_host_to_hostgroup`:
+    - `--dryrun`: Preview changes without making them.
+  - `create_host`:
+    - `--name`: Host name
+      - Host name still defaults to host DNS name or IP address if not specified.
+    - `--description`: Host description
+  - `create_hostgroup`:
+    - `--rw-groups`: User groups to give RW permissions to the host group.
+    - `--ro-groups`: User groups to give RO permissions to the host group. Uses groups from config file if not specified.
+    - `--no-usergroup-permissions`: Do not set user group permissions. Defaults to `false`.
+  - `create_host_interface`:
+    - `--snmp...` TODO
+  - `import_configuration`:
+    - `--dryrun`: Preview files to import.
+    - `--delete-missing`: Delete objects not found in the import file(s).
+  - `link_template_to_host`:
+    - `--dryrun`: Preview changes without making them.
+  - `remove_host_from_hostgroup`:
+    - `--dryrun`: Preview changes without making them.
+  - `show_host`:
+    - `--monitored/--unmonitored`: Filter by monitored status
+    - `--maintenance/--no-maintenance`: Filter by maintenance status
+    - `--active [available | unavailable | unknown ]`: Filter by active interface availability
+    - Old positional filter argument syntax is deprecated.
+  - `show_hosts`:
+    - `--limit`: Limit number of hosts to show.
+    - As well as the new `show_host` options.
+  - `show_hostgroup`:
+    - `--hosts/--no-hosts`: Show hosts in the group
+  - `show_hostgroups`:
+    - `--hosts/--no-hosts`: Show hosts in the group
+  - `show_trigger_events`
+    - `--trigger-id`: Trigger ID(s) to get events for.
+      - Corresponds to old positional argument 1.
+    - `--host`: Host(s) to get events for.
+    - `--hostgroup`: Host group(s) to get events for.
+    - `--limit`: Limit number of events to show
+      - Corresponds to old positional argument 2.
+      - Defaults to 10 (was 1).
+  - `show_usergroup`:
+    - `--sort`: Sort results by a field.
+  - `show_usergroups`:
+    - `--sort`: Sort results by a field.
+  - `show_usergroup_permissions`:
+    - `--sort`: Sort results by a field.
+  - `unlink_template_from_host`:
+    - `--dryrun`: Preview changes.
+  - `update_host_proxy`:
+    - `--dryrun`: Preview changes.
+- **New command arguments:**
+  - `show_templates`:
+    - `template_names`: Template name(s) to filter by. Shows all templates by default. Supports wildcards.
+  - `show_hostgroup`:
+    - `name`: Host group name(s) to filter by. Shows all host groups by default. Supports wildcards.
+
+### Changed
+
+- Commands now take named options instead of positional arguments.
+  - Positional arguments are deprecated.
+- JSON output is no longer always a dict with numeric string keys.
+  - See V3 migration guide for more information.
+  - The old format can be enabled with the new option `app.legacy_json_format` in the new TOML configuration file.
+  - When loading configuration from a legacy `.conf` file, the old format is assumed.
+- **TOML configuration file option names:**
+  - Table [zabbix_api] → [api]
+    - `zabbix_api_url` → `url`
+    - `cert_verify` → `verify_ssl`
+  - Table [zabbix_config] → [app]
+    - `system_id` → `username`
+    - `default_directory_exports` → `export_directory`
+    - `default_export_format` → `export_format`
+    - `include_timestamp_export_filename` → `export_timestamps`
+    - `allow_insecure_authfile` → `allow_insecure_auth_file`
+  - `logging.logging` → `logging.enabled`
+  - The original names are deprecated and slated for removal in a future version.
+- **Configuration file defaults:**
+  - `app.default_admin_usergroups` defaults to `[]` (empty list)
+  - `app.default_create_user_usergroups` defaults to `[]` (empty list)
+  - `app.export_timestamps` defaults to `false`
+    - Exports are automatically overwritten if the file already exists.
+  - `app.export_format` defaults to `json` (was `xml`)
+- Application now creates a config file on launch if it doesn't exist.
+- **Command changes:**
+  - `create_host_interface`
+    - Default port number is now determined by interface type.
+      - Agent: 10050
+      - SNMP: 161
+      - IPMI: 623
+      - JMX: 12345
+  - `define_host_monitoring_status`:
+    - Renamed to `monitor_host`.
+  - `link_template_to_hostgroup`:
+    - Renamed to `add_template_to_group`.
+  - `show_host_inventory`
+    - Now shows shows any inventory field that is set for the host in the table output.
+    - Includes _all_ inventory fields in JSON output.
+  - `show_hostgroup_permissions`:
+    - Shows permissions for all host groups by default.
+  - `show_proxies`:
+    - Now takes a `name_or_id` argument to filter by proxy name or ID. Comma-separated. Supports wildcards.
+  - `show_zabbixcli_config`:
+    - Renamed to `show_config`.
+  - `unlink_template_from_hostgroup`:
+    - Renamed to `remove_template_from_group`.
+    - No longer unlinks and clears templates from each other.
+      - This was a bug/misunderstanding of the Zabbix API in the old version.
+      - Use `unlink_template_from_template` to unlink and clear templates from each other.
+  - `update_host_proxy`
+    - Now supports setting proxy for multiple hosts at once using wildcards.
+    - Output format is changed.
+      - Now groups hosts by proxy prior to update.
+
+### Deprecated
+
+- `zabbix-cli.conf` format. Prefer the new TOML configuration file format.
+- Config file options:
+  - `zabbix_config.system_id` → `api.username`
+- **Commands:**
+  - `unlink_template_from_hostgroup`:
+    - Renamed to `remove_template_from_group`.
+  - `define_host_monitoring_status`:
+    - Renamed to `monitor_host`
+  - `show_zabbixcli_config`:
+    - Renamed to `show_config`
+- `zabbix-cli-init` script.
+  - Replaced by `zabbix-cli init` command.
+- `zabbix-cli-bulk-execution` script.
+  - Replaced by `zabbix-cli --file`.
+
+### Removed
+
+- Support for Zabbix <1.8 login using `user.authenticate`.
+
+### Internal
+
+- Use Hatch for building and publishing.
+- Switch from setup.py to pyproject.toml.
+- Add `pre-commit` hooks.
+- Add `pytest` tests
+- Use Ruff for linting and formatting.
+- Use Pyright for static type checking.
+- API code rewritten with Pydantic data models.