python-openstackclient 8.0.0__tar.gz → 8.1.0__tar.gz

{python_openstackclient-8.0.0 → python_openstackclient-8.1.0}/.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
         files: .*\.(yaml|yml)$
         args: ['--unsafe']
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.2
+    rev: v0.11.8
     hooks:
       - id: ruff
         args: ['--fix', '--unsafe-fixes']

{python_openstackclient-8.0.0 → python_openstackclient-8.1.0}/.zuul.yaml

@@ -23,8 +23,8 @@
       zuul_work_dir: src/opendev.org/openstack/python-openstackclient
 
 - job:
-    name: osc-tox-py39-tips
-    parent: openstack-tox-py39
+    name: osc-tox-py310-tips
+    parent: openstack-tox-py310
     description: |
       Run unit tests for OpenStackClient with master branch of important libs.
 
@@ -43,8 +43,8 @@
       zuul_work_dir: src/opendev.org/openstack/python-openstackclient
 
 - job:
-    name: osc-tox-py312-tips
-    parent: openstack-tox-py312
+    name: osc-tox-py313-tips
+    parent: openstack-tox-py313
     description: |
       Run unit tests for OpenStackClient with master branch of important libs.
 
@@ -137,22 +137,6 @@
       tox_envlist: functional
       tox_install_siblings: true
 
-- secret:
-    name: osc-dockerhub
-    data:
-      username: osclientzuul
-      password: !encrypted/pkcs1-oaep
-        - LbIZjJiVstRVXMpoLQ3+/JcNB6lKVUWJXXo5+Outf+PKAaO7mNnv8XLiFMKnJ6ftopLyu
-          hWbX9rA+NddvplLQkf1xxkh7QBBU8PToLr58quI2SENUclt4tpjxbZfZu451kFSNJvNvR
-          E58cHHpfJZpyRnS2htXmN/Qy24gbV2w7CQxSZD2YhlcrerD8uQ8rWEnlY1wcJEaEGomtS
-          ZTGxsdK2TsZC2cd4b7TG7+xbl2i+hjADzwSQAgUzlLlwuG71667+IWk4SOZ7OycJTv9NN
-          ZTak8+CGfiMKdmsxZ1Z8uD7DC+RIklDjMWyly6zuhWzfhOmsmU0CesR50moodRUvbK79p
-          NZM8u0hBex5cl2EpUEwJL/FSPJXUhDMPoMoTZT/SAuXf25R9eZ9JGrKsIAlmVhpl8ifoE
-          8TpPyvIHGS3YelTQjhqOX0wGb9T4ZauQCcI5Ajzy9NuCTyD9xxme9OX1zz7gMACRnVHvz
-          q7U7Ue90MnmGH6E2SgKjIZhyzy9Efwb7JUvH1Zb3hlrjCjEhwi9MV5FnABTEeXyYwE10s
-          3o/KZg2zvdWkVG6x0dEkjpoQaNuaB7T2Na7Sm421n/z3LCzhiQGuTUjENnL6cMEtuA6Pp
-          BfI5+Qlg7HMwkBXNB73EPfWHzbCR3VNrzGYTy9FvhGud0/cXsuBXgps4WH63ic=
-
 - job:
     name: osc-build-image
     parent: opendev-build-docker-image
@@ -162,49 +146,21 @@
       - python-builder-3.11-bookworm-container-image
       - python-base-3.11-bookworm-container-image
     provides: osc-container-image
-    vars: &osc_image_vars
+    vars:
       docker_images:
         - context: .
-          repository: osclient/python-openstackclient
-
-- job:
-    name: osc-upload-image
-    parent: opendev-upload-docker-image
-    description: Build Docker images and upload to Docker Hub.
-    allowed-projects: openstack/python-openstackclient
-    requires:
-      - python-builder-3.11-bookworm-container-image
-      - python-base-3.11-bookworm-container-image
-    provides: osc-container-image
-    secrets:
-      - name: docker_credentials
-        secret: osc-dockerhub
-        pass-to-parent: true
-    vars: *osc_image_vars
-
-- job:
-    name: osc-promote-image
-    parent: opendev-promote-docker-image
-    allowed-projects: openstack/python-openstackclient
-    description: Promote previously uploaded Docker images.
-    secrets:
-      - name: docker_credentials
-        secret: osc-dockerhub
-        pass-to-parent: true
-    nodeset:
-      nodes: []
-    vars: *osc_image_vars
+          tags: []
 
 - project-template:
     name: osc-tox-unit-tips
     check:
       jobs:
-        - osc-tox-py39-tips
-        - osc-tox-py312-tips
+        - osc-tox-py310-tips
+        - osc-tox-py313-tips
     gate:
       jobs:
-        - osc-tox-py39-tips
-        - osc-tox-py312-tips
+        - osc-tox-py310-tips
+        - osc-tox-py313-tips
 
 - project:
     templates:
@@ -226,8 +182,4 @@
             branches: ^master$
     gate:
       jobs:
-        - osc-upload-image
         - osc-functional-devstack
-    promote:
-      jobs:
-        - osc-promote-image

{python_openstackclient-8.0.0 → python_openstackclient-8.1.0}/AUTHORS

@@ -1,3 +1,4 @@
+0weng <oweng@osuosl.org>
 Aaron Rosen <aaronorosen@gmail.com>
 Abhishek Chanda <abhishek@cloudscaling.com>
 Abhishek Raut <rauta@vmware.com>
@@ -67,6 +68,7 @@ Carl Baldwin <carl@ecbaldwin.net>
 Carlos Goncalves <carlos.goncalves@neclab.eu>
 Carlos Konstanski <ckonstanski@pippiandcarlos.com>
 Cedric Brandily <zzelle@gmail.com>
+Chaemin-Lim <antraxmin@naver.com>
 Chaozhe.Chen <chaozhe.chen@easystack.cn>
 Chen <dstbtgagt@foxmail.com>
 Chen Hanxiao <chenhx@certusnet.com.cn>
@@ -119,6 +121,7 @@ Doug Hellmann <doug@doughellmann.com>
 Doug Wiegley <dwiegley@salesforce.com>
 Dougal Matthews <dougal@redhat.com>
 Douglas Mendizábal <dmendiza@redhat.com>
+Douglas Viroel <viroel@gmail.com>
 Dr. Jens Harbott <harbott@osism.tech>
 Einst Crazy <yu.changcai@99cloud.net>
 Elena Ezhova <eezhova@mirantis.com>
@@ -194,6 +197,7 @@ James E. Blair <jeblair@redhat.com>
 Jamie Lennox <jamielennox@redhat.com>
 Jan Gutter <jan.gutter@netronome.com>
 Jan Hartkopf <jhartkopf@inovex.de>
+Jan Ueberacker <jan.ueberacker@inovex.de>
 Jas <singhj@us.ibm.com>
 Jaspreet Singh Rawel <jaspreetsinghrawel@gmail.com>
 Javier Pena <jpena@redhat.com>
@@ -279,6 +283,7 @@ Matthieu Huin <mhu@enovance.com>
 Michael Gugino <michael.gugino@walmart.com>
 Michael Johnson <johnsomor@gmail.com>
 Michael McCune <msm@redhat.com>
+Michael Still <mikal@stillhq.com>
 Miguel Lavalle <miguel.lavalle@verizonmedia.com>
 Miguel Lavalle <mlavalle@redhat.com>
 Mike Fedosin <mfedosin@redhat.com>
@@ -465,6 +470,7 @@ choidoa-git <pearl097@naver.com>
 cw0306-lee <us0310306@gmail.com>
 daizhiyong <zhiyong.dai@easystack.cn>
 devMuscle <hongsbien@naver.com>
+djp <dimsss0607@gmail.com>
 dongwenshuai <dong.wenshuai@zte.com.cn>
 elajkat <lajos.katona@est.tech>
 gecong1973 <ge.cong@zte.com.cn>
@@ -544,6 +550,7 @@ ting wang <bx_wang@outlook.com>
 ting.wang <ting.wang@easystack.cn>
 venkata anil <anilvenkata@redhat.com>
 venkatamahesh <venkatamaheshkotha@gmail.com>
+waf <ekrmdhsl7@gmail.com>
 wanghong <w.wanghong@huawei.com>
 wangxiyuan <wangxiyuan@huawei.com>
 wangzihao <wangzihao@yovole.com>
@@ -553,6 +560,7 @@ wu.chunyang <wu.chunyang@99cloud.net>
 wu.chunyang <wuchunyang@yovole.com>
 wu.shiming <wushiming@yovole.com>
 wuyuting <wytdahu@gmail.com>
+xfrnk2 <xfrnk2@gmail.com>
 xiexs <xiexs@cn.fujitsu.com>
 yaeeee <rim0399@naver.com>
 yang wang <wangy@rc.inesa.com>

{python_openstackclient-8.0.0 → python_openstackclient-8.1.0}/ChangeLog

@@ -1,6 +1,53 @@
 CHANGES
 =======
 
+8.1.0
+-----
+
+* evacuate: respect original SHUTOFF state in --wait completion
+* Fix missing 'options' field in 'user show' command
+* Identity: Migrate 'group' commands to SDK
+* tests: Simplify mocking in image tests
+* network: Allow multiple FIP filter opts
+* volume: Migrate 'volume delete' to SDK
+* volume: Temporarily ignore new volume columns
+* volume: Split v2, v3 create, delete commands
+* volume: Migrate 'snapshot show', 'snapshot list' to SDK
+* volume: Migrate 'snapshot set', 'snapshot unset' to SDK
+* volume: Migrate 'snapshot create' to SDK
+* volume: Migrate 'snapshot delete' to SDK
+* volume: Add v3-specific volume snapshot module
+* tests: Use SDK mocks for SDK-based commands
+* volume: Migrate 'backup set', 'backup unset' to SDK
+* volume: Migrate 'service \*' to SDK
+* volume: Add v3-specific volume service module
+* volume: Migrate 'block storage log level \*' to SDK
+* Add a column to all\_projects tag of server list cmd
+* Fix incorrect warning with --password-prompt option
+* compute: Fix key used for NIC fixed IP field
+* identity: Add missing user argument
+* identity: Fix listing of applications credentials by user
+* Bump Python version used for linters to 3.10
+* Drop support for Python 3.9
+* Add support for spice-direct console types
+* Update README
+* Add labels to Dockerfile
+* Update the docker image to python3.12
+* zuul: Remove osc-upload-image, osc-promote-image jobs
+* tests: Stop returning FakeResource in compute tests
+* tests: Remove sdk prefix
+* tests: Remove dead code
+* tests: Remove use of legacy resource helpers
+* Require confirmation to reset server state
+* Fix 'openstack keypair list --project <project>'
+* Don't warn about unsupported version with SDK-based commands
+* Workaround for failing tests on openstacksdk change
+* Add support for showing scheduler\_hints in server details
+* Refactor network fakes to sdk properties PART6
+* Refactor network fakes to sdk properties PART 5
+* volume: Make better use of argparse
+* image: Migrate 'create image' volume calls to SDK
+
 8.0.0
 -----
 
@@ -27,6 +74,7 @@ CHANGES
 * pre-commit: Bump versions
 * Fix neutron typos and formatting
 * Return the \`\`port\`\` column headers expected in the list command
+* Add filters to search for enabled/disabled users and projects
 * [Neutron] Add "qos-policy" parameter to router creation command
 * Fix networking quota usage show
 * Replace description-content-type by its underscore name
@@ -84,6 +132,7 @@ CHANGES
 * network: Make better use of argparse
 * compute: Add server create --no-security-group option
 * Remove ceilometer service overrides
+* identity: Migrate 'domain' commands to SDK
 * identity: Migrate \`region\` commands to SDK
 * reno: Update master for unmaintained/2023.1
 * identity: Migrate 'credential' commands to SDK

{python_openstackclient-8.0.0 → python_openstackclient-8.1.0}/Dockerfile

@@ -13,12 +13,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-FROM docker.io/opendevorg/python-builder:3.11-bookworm as builder
+FROM docker.io/opendevorg/python-builder:3.12-bookworm AS builder
 
 COPY . /tmp/src
 RUN assemble
 
-FROM docker.io/opendevorg/python-base:3.11-bookworm
+FROM docker.io/opendevorg/python-base:3.12-bookworm
+
+LABEL org.opencontainers.image.title="python-openstackclient"
+LABEL org.opencontainers.image.description="Client for OpenStack services."
+LABEL org.opencontainers.image.licenses="Apache License 2.0"
+LABEL org.opencontainers.image.url="https://www.openstack.org/"
+LABEL org.opencontainers.image.documentation="https://docs.openstack.org/python-openstackclient/latest/"
+LABEL org.opencontainers.image.source="https://opendev.org/openstack/python-openstackclient"
 
 COPY --from=builder /output/ /output
 RUN /output/install-from-bindep

python_openstackclient-8.1.0/PKG-INFO

@@ -0,0 +1,263 @@
+Metadata-Version: 2.1
+Name: python-openstackclient
+Version: 8.1.0
+Summary: OpenStack Command-line Client
+Home-page: https://docs.openstack.org/python-openstackclient/latest/
+Author: OpenStack
+Author-email: openstack-discuss@lists.openstack.org
+Classifier: Environment :: OpenStack
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: pbr!=2.1.0,>=2.0.0
+Requires-Dist: cryptography>=2.7
+Requires-Dist: cliff>=3.5.0
+Requires-Dist: iso8601>=0.1.11
+Requires-Dist: openstacksdk>=4.5.0
+Requires-Dist: osc-lib>=2.3.0
+Requires-Dist: oslo.i18n>=3.15.3
+Requires-Dist: python-keystoneclient>=3.22.0
+Requires-Dist: python-cinderclient>=3.3.0
+Requires-Dist: requests>=2.27.0
+Requires-Dist: stevedore>=2.0.1
+
+===============
+OpenStackClient
+===============
+
+.. image:: https://img.shields.io/pypi/v/python-openstackclient.svg
+    :target: https://pypi.org/project/python-openstackclient/
+    :alt: Latest Version
+
+OpenStackClient (OSC) is a command-line client for OpenStack that brings
+the command set for Compute, Identity, Image, Network, Object Store and Block
+Storage APIs together in a single shell with a uniform command structure.
+Support for additional service APIs is provided via plugins.
+
+The primary goal is to provide a unified shell command structure and a common
+language to describe operations in OpenStack.
+
+Getting Started
+===============
+
+OpenStack Client can be installed from PyPI using pip:
+
+.. code-block:: shell
+
+    python3 -m pip install python-openstackclient
+
+You can use ``--help`` or the ``help`` command to get a list of global options
+and supported commands:
+
+.. code-block:: shell
+
+    openstack --help
+    openstack help
+
+You can also get help for a specific command:
+
+.. code-block:: shell
+
+    openstack server create --help
+    openstack help server create
+
+You can add support for additional services by installing their clients. For
+example, to add support for the DNS service (designate):
+
+.. code-block:: shell
+
+    python3 -m pip install python3-designateclient
+
+A ``Dockerfile`` is provided for your convenience in the repository. You can
+use this to build your own container images:
+
+.. code-block:: shell
+
+    git clone https://opendev.org/openstack/python-openstackclient
+    cd python-openstackclient
+    podman build . -t example.com/myuser/openstackclient
+
+For more information the available options and commands, refer to the `Users
+Guide`__.
+
+.. __: https://docs.openstack.org/python-openstackclient/latest/cli/index.html
+
+Configuration
+=============
+
+OpenStack Client must be configured with authentication information in order to
+communicate with a given OpenStack cloud. This configuration can be achieved
+via a ``clouds.yaml`` file, a set of environment variables (often shared via an
+``openrc`` file), a set of command-line options, or a combination of all three.
+Your cloud provider or deployment tooling will typically provide either a
+``clouds.yaml`` file or ``openrc`` file for you. If using a ``clouds.yaml``
+file, OpenStack Client expects to find it in one of the following locations:
+
+* If set, the path indicated by the ``OS_CLIENT_CONFIG_FILE`` environment
+  variable
+* ``.`` (the current directory)
+* ``$HOME/.config/openstack``
+* ``/etc/openstack``
+
+The options you should set will depend on the configuration of your cloud and
+the authentication mechanism(s) supported. For example, consider a cloud that
+supports username/password authentication. Configuration for this cloud using a
+``clouds.yaml`` file would look like so:
+
+.. code-block:: yaml
+
+    clouds:
+      my-cloud:
+        auth:
+          auth_url: '<url-to-openstack-identity>'
+          project_name: '<project-name>'
+          project_domain_name: '<project-domain-name>'
+          username: '<username>'
+          user_domain_name: '<user-domain-name>'
+          password: '<password>'  # (optional)
+        region_name: '<region>'
+
+The corresponding environment variables would look very similar:
+
+.. code-block:: shell
+
+    export OS_AUTH_URL=<url-to-openstack-identity>
+    export OS_REGION_NAME=<region>
+    export OS_PROJECT_NAME=<project-name>
+    export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
+    export OS_USERNAME=<username>
+    export OS_USER_DOMAIN_NAME=<user-domain-name>
+    export OS_PASSWORD=<password>  # (optional)
+
+Likewise, the corresponding command-line options would look very similar:
+
+::
+
+    openstack
+    --os-auth-url <url-to-openstack-identity>
+    --os-region <region>
+    --os-project-name <project-name>
+    --os-project-domain-name <project-domain-name>
+    --os-username <username>
+    --os-user-domain-name <user-domain-name>
+    [--os-password <password>]
+
+.. note::
+
+    If a password is not provided above (in plaintext), you will be
+    interactively prompted to provide one securely.
+
+Some clouds use federated authentication. If this is the case, your
+configuration will be slightly more involved. For example, to configure
+username/password authentication for a federated user using a ``clouds.yaml``
+file:
+
+.. code-block:: yaml
+
+    clouds:
+      my-cloud:
+        auth:
+          auth_url: '<url-to-openstack-identity>'
+          project_name: '<project-name>'
+          project_domain_name: '<project-domain-name>'
+          username: '<username-in-idp>'
+          user_domain_name: '<user-domain-name>'
+          password: '<password-in-idp>'
+          identity_provider: '<the-desired-idp-in-keystone>'
+          client_id: '<the-client-id-configured-in-the-idp>'
+          client_secret: '<the-client-secret-configured-in-the-idp>'
+          openid_scope: '<the-scopes-of-desired-attributes-to-claim-from-idp>'
+          protocol: '<the-protocol-used-in-the-apache2-oidc-proxy>'
+          access_token_type: '<the-access-token-type-used-by-your-idp>'
+          discovery_endpoint: '<the-well-known-endpoint-of-the-idp>'
+        auth_type: 'v3oidcpassword'
+        region_name: '<region>'
+
+The corresponding environment variables would look very similar:
+
+.. code-block:: shell
+
+    export OS_PROJECT_NAME=<project-name>
+    export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
+    export OS_AUTH_URL=<url-to-openstack-identity>
+    export OS_IDENTITY_API_VERSION=3
+    export OS_AUTH_TYPE=v3oidcpassword
+    export OS_USERNAME=<username-in-idp>
+    export OS_PASSWORD=<password-in-idp>
+    export OS_IDENTITY_PROVIDER=<the-desired-idp-in-keystone>
+    export OS_CLIENT_ID=<the-client-id-configured-in-the-idp>
+    export OS_CLIENT_SECRET=<the-client-secred-configured-in-the-idp>
+    export OS_OPENID_SCOPE=<the-scopes-of-desired-attributes-to-claim-from-idp>
+    export OS_PROTOCOL=<the-protocol-used-in-the-apache2-oidc-proxy>
+    export OS_ACCESS_TOKEN_TYPE=<the-access-token-type-used-by-your-idp>
+    export OS_DISCOVERY_ENDPOINT=<the-well-known-endpoint-of-the-idp>
+
+Likewise, the corresponding command-line options would look very similar:
+
+.. code-block:: shell
+
+    --os-project-name <project-name>
+    --os-project-domain-name <project-domain-name>
+    --os-auth-url <url-to-openstack-identity>
+    --os-identity-api-version 3
+    --os-auth-plugin openid
+    --os-auth-type v3oidcpassword
+    --os-username <username-in-idp>
+    --os-password <password-in-idp>
+    --os-identity-provider <the-desired-idp-in-keystone>
+    --os-client-id <the-client-id-configured-in-the-idp>
+    --os-client-secret <the-client-secred-configured-in-the-idp>
+    --os-openid-scope <the-scopes-of-desired-attributes-to-claim-from-idp>
+    --os-protocol <the-protocol-used-in-the-apache2-oidc-proxy>
+    --os-access-token-type <the-access-token-type-used-by-your-idp>
+    --os-discovery-endpoint <the-well-known-endpoint-of-the-idp>
+
+For more information on configuring authentication, including an overview of
+the many authentication mechanisms supported, refer to the `Authentication
+guide`__. For more information on configuration in general, refer to the
+`Configuration guide`__.
+
+.. __: https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html.
+.. __: https://docs.openstack.org/python-openstackclient/latest/configuration/index.html
+
+Contributing
+============
+
+You can clone the repository from opendev.org::
+
+    git clone https://opendev.org/openstack/python-openstackclient
+    cd python-openstackclient
+
+OpenStack Client uses the same contributor process as other OpenStack projects.
+For information on this process, including help on setting up you Gerrit
+account and an overview of the CI process, refer to the `OpenStack Contributors
+Guide`__.
+
+For more information on contributing to OpenStack Client itself, including
+guidance on how to design new commands and how to report bugs, refer to the
+`Contributors Guide`__.
+
+.. __: https://docs.openstack.org/python-openstackclient/latest/contributor/index.html
+.. __: https://docs.opendev.org/opendev/infra-manual/latest/developers.html
+
+Links
+-----
+
+* `Issue Tracker <https://bugs.launchpad.net/python-openstackclient>`_
+* `Code Review <https://review.opendev.org/#/q/status:open+project:openstack/openstacksdk,n,z>`_
+* `Documentation <https://docs.openstack.org/python-openstackclient/latest/>`_
+* `PyPi <https://pypi.org/project/python-openstackclient>`_
+* `Mailing list <https://lists.openstack.org/mailman3/lists/openstack-discuss.lists.openstack.org/>`_
+* `Release Notes <https://docs.openstack.org/releasenotes/python-openstackclient>`_
+* `IRC (#openstack-sdks on OFTC (irc.oftc.net)) <irc://irc.oftc.net/openstack-sdks>`_
+