python-doniclient 1.0.3__tar.gz → 1.2.1__tar.gz

python_doniclient-1.2.1/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

python_doniclient-1.2.1/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - 'chameleoncloud/*'
+  pull_request:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install tox
+      - run: tox -e py

python_doniclient-1.2.1/.github/workflows/publish.yml

@@ -0,0 +1,45 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+
+  build:
+    needs: test
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          # pbr takes the version from the release tag, so it needs tags
+          fetch-depth: 0
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - run: python -m pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v7
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/p/python-doniclient
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

python_doniclient-1.2.1/.stestr.conf

@@ -0,0 +1,3 @@
+[DEFAULT]
+test_path=${TESTS_DIR:-./doniclient/tests}
+top_dir=./

python_doniclient-1.2.1/.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Unit Test",
+            "type": "python",
+            "request": "launch",
+            "purpose": ["debug-test"],
+            "justMyCode": false,
+        },
+        {
+            "name": "Hardware List",
+            "type": "python",
+            "request": "launch",
+            "cwd": "${workspaceFolder}",
+            "program": ".venv/bin/openstack",
+            "args": [
+                "hardware",
+                "list",
+                "--long"
+            ],
+            "justMyCode": false,
+            "envFile": "${workspaceFolder}/debug.env",
+        },
+    ]
+}

python_doniclient-1.2.1/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./doniclient",
+        "-p",
+        "test*.py"
+    ],
+    "python.testing.unittestEnabled": true,
+}

python_doniclient-1.2.1/AUTHORS

@@ -0,0 +1,12 @@
+Anish Reddy <2anishreddy@gmail.com>
+Anish Reddy Ravula <2anishreddy@gmail.com>
+Jason <diurnalist@gmail.com>
+Jason Anderson <796413+diurnalist@users.noreply.github.com>
+Jason Anderson <jasonanderson@uchicago.edu>
+Mark Powers <markpowers@uchicago.edu>
+Michael Sherman <shermanm@uchicago.edu>
+Mike <msherman64@gmail.com>
+Mike <shermanm@uchicago.edu>
+Soufiane Jounaid <38963565+JOUNAIDSoufiane@users.noreply.github.com>
+dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

python_doniclient-1.2.1/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing 
+
+## Testing
+
+Run the tests using `tox -e py`
+
+
+## Publishing new versions
+
+Releases are published to PyPI by the [publish workflow](.github/workflows/publish.yml), using PyPI trusted publishing. The version comes from the git tag (via pbr), so there is no version to edit before releasing.
+
+To release, create a GitHub release with a new tag named `vX.Y.Z`, and set its target to the branch you are releasing from. Publishing the release runs the tests, builds the package and uploads it to PyPI.
+
+Use tags like `v1.1.0rc1` for pre-releases. GitHub's pre-release checkbox doesn't change the version uploaded to PyPI.

python_doniclient-1.2.1/ChangeLog

@@ -0,0 +1,191 @@
+CHANGES
+=======
+
+v1.2.1
+------
+
+* version from git tags
+* Wip/cleanup ci publish (#121)
+* ci: publish stestr results as junit
+* ci: test python 3.10 through 3.12
+* ci: run unit tests in a python version matrix
+* Bump actions/checkout from 6 to 7
+
+v1.2.0
+------
+
+* bump requirements and python for 2025.1
+
+v1.1.0
+------
+
+* bump requirements and python for 2024.1
+
+v1.0.4
+------
+
+* add publish workflow
+* clean up CI noise
+* feat: remove poetry, update deps and tox
+* Soufianej pyyaml upgrade to fix python sources build error (#110)
+* Unset feature (#105)
+* refactor of prop\_flag\_group (#108)
+* Update the readme with the command usage
+* hardware list to show last\_error from each worker
+* add "name\_or\_uuid" support to "sync" command
+* fix ordering of worker-task columns (#103)
+* Show and filter by worker\_state and type (#102)
+* Set and delete using name of HW (#100)
+* create set \`mgmt\_addr\` instead of \`management\_address\` in error
+* fix unittest for hardware show
+* [ci] fix configuration for local untitests
+* fix pyyaml dependency issue
+* Bump up version to 5.6.2 for xena constraints (#99)
+
+v1.0.3
+------
+
+* bump version for release
+* ensure CI checks are useful (#87)
+* allow setting local egress property for devices (#85)
+* Add test cases for "hardware set"
+* update formatter
+* bump release version
+* add --long flag to list all columns
+* add vscode debug config
+* Update python to 3.7 minimum, neeeded fpo xena
+* upgrade dependencies for xena
+* allow retrieval of infomation by name (#57)
+* 0.5.2
+* fix bug w/ patch command
+
+v0.5.1
+------
+
+* 0.5.1
+* fixup hardware type parsing
+* add contributor guide
+
+v0.5.0
+------
+
+* 0.5.0
+* Add support for device hwtype
+* bump version
+* ensure 'set' takes a uuid
+* Allow json input of arbitrary arguments, refactor cli (#49)
+* rename package to python-doniclient (#48)
+* hotfix release, syntax error in cli.py
+
+v0.4.0
+------
+
+* 0.4.0
+* add support for setting deploy kernel and ramdisk
+* allow import to continue on conflict
+* fix properties path and delete logic for update
+
+v0.3.0
+------
+
+* 0.3.0
+* Apply suggestions from code review
+* Change workers column to use yaml formatter
+* Fix parameter formatting
+* Add workers to serializer if exists in data
+
+v0.2.5
+------
+
+* 0.2.5
+* Invert openstack constraints
+
+v0.2.4
+------
+
+* 0.2.4
+* Make hardware formatter generic
+* Format properties field in a nicer way
+* Add dependency on PyYAML
+* Fix listing of own hardware
+
+v0.2.3
+------
+
+* Bugfix/ci (#12)
+
+v0.2.2
+------
+
+* add author and bump version
+* add extra network info keys to interface command
+
+v0.2.1
+------
+
+* 0.2.1
+* Fix bug with hardware create
+
+v0.2.0
+------
+
+* 0.2.0
+* Add sub commands for managing availability windows
+* Move \_format\_iface
+* quickfix to add upper-constraint behavior
+* add description
+
+v0.1.4
+------
+
+* 0.1.4
+* Downgrade to Train release versions
+* Bugfix/initial release (#6)
+* make dependabot less chatty
+
+v0.1.1
+------
+
+* 0.1.1
+* Use requirements from Train release
+
+v0.1
+----
+
+* update create helptext
+* fix creation of availability windows
+* add tz to parsed dates
+* add more update parser robustness
+* handle edge cases for update
+* add date parsing to update method
+* clean up help and parsing for windows
+* add dateutil dependency
+* add delete and sync, some refactoring
+* add syc call
+* add delete call
+* improve handling of iface updates
+* fix handling of top level variables
+* add handling for interface list
+* update calls succeed for subset of fields (#3)
+* add bits for jsonpatch
+* handle dry run
+* create hardware works
+* add create function
+* removed osc\_lib.api due to url parsing issues
+* list and export work, find has a weird http/s bug
+* separate osc client and doni client
+* change create name
+* get single works
+* use command.Lister for standard output formatting
+* fix auth and implement list and export
+* add unittest stubs for methods
+* add openstackclient as extras dep
+* add osc entrypoints
+* rename files following ironicclient
+* Add openstack client deps
+* add lint and test settings
+* Bump pytest from 5.4.3 to 6.2.2 (#1)
+* add gh actions
+* add dev dependencies
+* inital commit
+* Initial commit

python_doniclient-1.2.1/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: python-doniclient
+Version: 1.2.1
+Summary: This is a plugin for the openstack commandline client, to enable support for the Doni hardware inventory project
+Author-email: Chameleon Cloud <contact@chameleoncloud.org>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/ChameleonCloud/python-doniclient
+Classifier: Environment :: OpenStack
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: osc-lib
+Requires-Dist: python-dateutil
+Requires-Dist: PyYAML>=5.4.1
+Requires-Dist: keystoneauth1
+
+# ChameleonCloud Python Doniclient CLI
+
+![ChameleonCloud Logo](https://www.chameleoncloud.org/static/images/logo.png)
+
+Welcome to the ChameleonCloud Python Doniclient CLI repository! This command-line interface (CLI) provides a convenient way to interact with ChameleonCloud's Doni hardware inventory project, enabling you to manage and automate various hardware-related tasks.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Authentication](#authentication)
+- [Usage](#usage)
+- [Testing](#testing)
+- [Contributing](#contributing)
+
+## Installation
+
+You can install the ChameleonCloud Python Doniclient CLI using pip:
+
+```bash
+pip install python-doniclient
+```
+
+### Cython sources issue
+if you encounter an error message citing cython sources, please run the following to downgrade cython to a compatible version and use PyYaml 6.0+
+```pip install "cython<3.0.0"```
+
+## Authentication
+Environment variables are the primary authentication method. Please refer to the [documentation on OpenRC scripts](https://chameleoncloud.readthedocs.io/en/latest/technical/cli.html#the-openstack-rc-script)  to learn more about how to download and source your authentication credentials for the CLI;
+
+## Usage
+To use the CLI, you can run the `openstack hardware` command followed by the desired subcommand. `openstack hardware --help` shows all the subcommands available. Here's a basic usage examples:
+
+### List all hardware in the Doni database.
+
+```bash
+openstack hardware list
+```
+
+Options:
+
+- --all: List hardware from all owners (requires admin rights).
+- --long: Include all columns in the output.
+- --worker-type <worker_type>: Filter by worker type.
+- --worker-state <worker_state>: Filter by worker state (choices: PENDING, IN_PROGRESS, ERROR, STEADY).
+
+For more details on specific commands and their options use --help or -h
+
+### Create hardware in the Doni database
+
+```bash
+openstack hardware create --name <hardware_name> --hardware-type <hardware_type> --property <property_name>=<property_value>
+```
+
+### List specific hardware item in Doni using name or uuid.
+
+```bash
+openstack hardware get <hardware_uuid>
+```
+
+```bash
+openstack hardware get <hardware_name>
+```
+
+### Set properties and name of an existing hardware item.
+
+```bash
+openstack hardware set <hardware_uuid> --name <new_hardware_name> --property <property_name>=<new_property_value>
+```
+
+Sets new name and property for the item `<hardware_uuid>`
+
+```bash
+openstack hardware set <hardware_name> --property <property_name>=<new_property_value>
+```
+
+Sets property for the item `<hardware_name`
+
+### Unset properties of an existing hardware item.
+
+```bash
+openstack hardware unset <hardware_uuid> --property <property_name>
+```
+
+Unsets property `<property_name>` for the item `<hardware_uuid`
+
+```bash
+openstack hardware update <hardware_name> --property <property_name>=<new_property_value>
+```
+
+Unsets property `<property_name>` for the item `<hardware_name>`

python_doniclient-1.2.1/README.md

@@ -0,0 +1,90 @@
+# ChameleonCloud Python Doniclient CLI
+
+![ChameleonCloud Logo](https://www.chameleoncloud.org/static/images/logo.png)
+
+Welcome to the ChameleonCloud Python Doniclient CLI repository! This command-line interface (CLI) provides a convenient way to interact with ChameleonCloud's Doni hardware inventory project, enabling you to manage and automate various hardware-related tasks.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Authentication](#authentication)
+- [Usage](#usage)
+- [Testing](#testing)
+- [Contributing](#contributing)
+
+## Installation
+
+You can install the ChameleonCloud Python Doniclient CLI using pip:
+
+```bash
+pip install python-doniclient
+```
+
+### Cython sources issue
+if you encounter an error message citing cython sources, please run the following to downgrade cython to a compatible version and use PyYaml 6.0+
+```pip install "cython<3.0.0"```
+
+## Authentication
+Environment variables are the primary authentication method. Please refer to the [documentation on OpenRC scripts](https://chameleoncloud.readthedocs.io/en/latest/technical/cli.html#the-openstack-rc-script)  to learn more about how to download and source your authentication credentials for the CLI;
+
+## Usage
+To use the CLI, you can run the `openstack hardware` command followed by the desired subcommand. `openstack hardware --help` shows all the subcommands available. Here's a basic usage examples:
+
+### List all hardware in the Doni database.
+
+```bash
+openstack hardware list
+```
+
+Options:
+
+- --all: List hardware from all owners (requires admin rights).
+- --long: Include all columns in the output.
+- --worker-type <worker_type>: Filter by worker type.
+- --worker-state <worker_state>: Filter by worker state (choices: PENDING, IN_PROGRESS, ERROR, STEADY).
+
+For more details on specific commands and their options use --help or -h
+
+### Create hardware in the Doni database
+
+```bash
+openstack hardware create --name <hardware_name> --hardware-type <hardware_type> --property <property_name>=<property_value>
+```
+
+### List specific hardware item in Doni using name or uuid.
+
+```bash
+openstack hardware get <hardware_uuid>
+```
+
+```bash
+openstack hardware get <hardware_name>
+```
+
+### Set properties and name of an existing hardware item.
+
+```bash
+openstack hardware set <hardware_uuid> --name <new_hardware_name> --property <property_name>=<new_property_value>
+```
+
+Sets new name and property for the item `<hardware_uuid>`
+
+```bash
+openstack hardware set <hardware_name> --property <property_name>=<new_property_value>
+```
+
+Sets property for the item `<hardware_name`
+
+### Unset properties of an existing hardware item.
+
+```bash
+openstack hardware unset <hardware_uuid> --property <property_name>
+```
+
+Unsets property `<property_name>` for the item `<hardware_uuid`
+
+```bash
+openstack hardware update <hardware_name> --property <property_name>=<new_property_value>
+```
+
+Unsets property `<property_name>` for the item `<hardware_name>`