========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/python-cyborgclient.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
===============================
python-cyborgclient
===============================
.. image:: https://img.shields.io/pypi/v/python-cyborgclient.svg
:target: https://pypi.python.org/pypi/python-cyborgclient/
:alt: Latest Version
python-cyborgclient is a python bindings to the OpenStack Cyborg API. There's
a Python API (the ``cyborgclient`` module), and a command-line script
(``cyborg``). Each implements 100% of the OpenStack Cyborg API.
See the `OpenStack CLI Reference`_ for information on how to use the ``cyborg``
command-line tool. You may also want to look at the
`OpenStack API documentation`_.
.. _OpenStack CLI Reference: https://docs.openstack.org/python-openstackclient/latest/cli/
.. _OpenStack API documentation: https://docs.openstack.org/api-quick-start/
The project is hosted on `Launchpad`_, where bugs can be filed. The code is
hosted on `OpenStack`_. Patches must be submitted using `Gerrit`_.
.. _OpenStack: https://git.openstack.org/cgit/openstack/python-cyborgclient
.. _Launchpad: https://launchpad.net/python-cyborgclient
.. _Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow
This code is a fork of `Jacobian's python-cloudservers`__. If you need API support
for the Rackspace API solely or the BSD license, you should use that repository.
python-cyborgclient is licensed under the Apache License like the rest of OpenStack.
__ https://github.com//rackerlabs/python-cloudservers
* License: Apache License, Version 2.0
* `PyPi`_ - package installation
* `Online Documentation`_
* `Blueprints`_ - feature specifications
* `Bugs`_ - issue tracking
* `Source`_
* `Specs`_
* `How to Contribute`_
.. _PyPi: https://pypi.python.org/pypi/python-cyborgclient
.. _Online Documentation: https://docs.openstack.org/python-cyborgclient/latest/
.. _Blueprints: https://blueprints.launchpad.net/python-cyborgclient
.. _Bugs: https://bugs.launchpad.net/python-cyborgclient
.. _Source: https://git.openstack.org/cgit/openstack/python-cyborgclient
.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html
.. _Specs: https://specs.openstack.org/openstack/cyborg-specs/
.. contents:: Contents:
:local:
Command-line API
----------------
Installing this package gets you a shell command, ``cyborg``, that you
can use to interact with any Rackspace compatible API (including OpenStack).
You'll need to provide your OpenStack username and password. You can do this
with the ``--os-username``, ``--os-password`` and ``--os-tenant-name``
params, but it's easier to just set them as environment variables::
export OS_USERNAME=openstack
export OS_PASSWORD=yadayada
export OS_TENANT_NAME=myproject
You will also need to define the authentication url with ``--os-auth-url``
and the version of the API with ``--os-accelerator-api-version``. Or set them
as environment variables as well, ``OS_ACCELERATOR_API_VERSION=1``. If you
are using Keystone, you need to set the ``OS_AUTH_URL`` to the keystone
endpoint::
export OS_AUTH_URL=http://controller:5000/v3
export OS_ACCELERATOR_API_VERSION=1
Since Keystone can return multiple regions in the Service Catalog, you
can specify the one you want with ``--os-region-name`` (or
``export OS_REGION_NAME``). It defaults to the first in the list returned.
You'll find complete documentation on the shell by running
``cyborg help``
Python API
----------
There's also a complete Python API, but it has not yet been documented.
Quick-start using keystone::
# pass auth plugin and session to Client init.
# service_parameters contains servive_name, service_type, interface and
# region name.
>>> from cyborgclient.v1 import client
>>> nt = client.Client(auth=auth,session=_SESSION,**service_parameters)
>>> nt.accelerators.list()
[...]
See release notes and more at `<https://docs.openstack.org/python-cyborgclient/latest/>`_.
Raw data
{
"_id": null,
"home_page": "https://docs.openstack.org/python-cyborgclient/latest/",
"name": "python-cyborgclient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/f3/94/43af62df1f8986043e99d456713b0d20b93d97b47ffcb3b4ae082bfbea37/python-cyborgclient-2.4.0.tar.gz",
"platform": null,
"description": "========================\nTeam and repository tags\n========================\n\n.. image:: https://governance.openstack.org/tc/badges/python-cyborgclient.svg\n :target: https://governance.openstack.org/tc/reference/tags/index.html\n\n.. Change things from this point on\n\n===============================\npython-cyborgclient\n===============================\n\n.. image:: https://img.shields.io/pypi/v/python-cyborgclient.svg\n :target: https://pypi.python.org/pypi/python-cyborgclient/\n :alt: Latest Version\n\npython-cyborgclient is a python bindings to the OpenStack Cyborg API. There's\na Python API (the ``cyborgclient`` module), and a command-line script\n(``cyborg``). Each implements 100% of the OpenStack Cyborg API.\n\nSee the `OpenStack CLI Reference`_ for information on how to use the ``cyborg``\ncommand-line tool. You may also want to look at the\n`OpenStack API documentation`_.\n\n.. _OpenStack CLI Reference: https://docs.openstack.org/python-openstackclient/latest/cli/\n.. _OpenStack API documentation: https://docs.openstack.org/api-quick-start/\n\nThe project is hosted on `Launchpad`_, where bugs can be filed. The code is\nhosted on `OpenStack`_. Patches must be submitted using `Gerrit`_.\n\n.. _OpenStack: https://git.openstack.org/cgit/openstack/python-cyborgclient\n.. _Launchpad: https://launchpad.net/python-cyborgclient\n.. _Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow\n\nThis code is a fork of `Jacobian's python-cloudservers`__. If you need API support\nfor the Rackspace API solely or the BSD license, you should use that repository.\npython-cyborgclient is licensed under the Apache License like the rest of OpenStack.\n\n__ https://github.com//rackerlabs/python-cloudservers\n\n* License: Apache License, Version 2.0\n* `PyPi`_ - package installation\n* `Online Documentation`_\n* `Blueprints`_ - feature specifications\n* `Bugs`_ - issue tracking\n* `Source`_\n* `Specs`_\n* `How to Contribute`_\n\n.. _PyPi: https://pypi.python.org/pypi/python-cyborgclient\n.. _Online Documentation: https://docs.openstack.org/python-cyborgclient/latest/\n.. _Blueprints: https://blueprints.launchpad.net/python-cyborgclient\n.. _Bugs: https://bugs.launchpad.net/python-cyborgclient\n.. _Source: https://git.openstack.org/cgit/openstack/python-cyborgclient\n.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html\n.. _Specs: https://specs.openstack.org/openstack/cyborg-specs/\n\n\n.. contents:: Contents:\n :local:\n\n\nCommand-line API\n----------------\n\nInstalling this package gets you a shell command, ``cyborg``, that you\ncan use to interact with any Rackspace compatible API (including OpenStack).\n\nYou'll need to provide your OpenStack username and password. You can do this\nwith the ``--os-username``, ``--os-password`` and ``--os-tenant-name``\nparams, but it's easier to just set them as environment variables::\n\n export OS_USERNAME=openstack\n export OS_PASSWORD=yadayada\n export OS_TENANT_NAME=myproject\n\nYou will also need to define the authentication url with ``--os-auth-url``\nand the version of the API with ``--os-accelerator-api-version``. Or set them\nas environment variables as well, ``OS_ACCELERATOR_API_VERSION=1``. If you\nare using Keystone, you need to set the ``OS_AUTH_URL`` to the keystone\nendpoint::\n\n export OS_AUTH_URL=http://controller:5000/v3\n export OS_ACCELERATOR_API_VERSION=1\n\nSince Keystone can return multiple regions in the Service Catalog, you\ncan specify the one you want with ``--os-region-name`` (or\n``export OS_REGION_NAME``). It defaults to the first in the list returned.\n\nYou'll find complete documentation on the shell by running\n``cyborg help``\n\n\nPython API\n----------\n\nThere's also a complete Python API, but it has not yet been documented.\n\nQuick-start using keystone::\n\n # pass auth plugin and session to Client init.\n # service_parameters contains servive_name, service_type, interface and\n # region name.\n >>> from cyborgclient.v1 import client\n >>> nt = client.Client(auth=auth,session=_SESSION,**service_parameters)\n >>> nt.accelerators.list()\n [...]\n\nSee release notes and more at `<https://docs.openstack.org/python-cyborgclient/latest/>`_.\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python client for cyborg API",
"version": "2.4.0",
"project_urls": {
"Homepage": "https://docs.openstack.org/python-cyborgclient/latest/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bfd2b9ff930a9081f621d1930270853a434d5552c6b28783cefad1dd23ba29d4",
"md5": "034841962248fa552ada6c0f3da10727",
"sha256": "d8cd246bac9b6d696d6d26ab08dc6c96b5dab84370d5b2f6d663037d0d985bba"
},
"downloads": -1,
"filename": "python_cyborgclient-2.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "034841962248fa552ada6c0f3da10727",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 93904,
"upload_time": "2024-05-16T12:53:42",
"upload_time_iso_8601": "2024-05-16T12:53:42.446224Z",
"url": "https://files.pythonhosted.org/packages/bf/d2/b9ff930a9081f621d1930270853a434d5552c6b28783cefad1dd23ba29d4/python_cyborgclient-2.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f39443af62df1f8986043e99d456713b0d20b93d97b47ffcb3b4ae082bfbea37",
"md5": "58e64737bd2aa7c2dcf77ec29151d9e5",
"sha256": "cc9c1f4b91ff5a043bd6370799036dd1b9707087bc50eda6ec76f0088b929530"
},
"downloads": -1,
"filename": "python-cyborgclient-2.4.0.tar.gz",
"has_sig": false,
"md5_digest": "58e64737bd2aa7c2dcf77ec29151d9e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 71697,
"upload_time": "2024-05-16T12:53:44",
"upload_time_iso_8601": "2024-05-16T12:53:44.281087Z",
"url": "https://files.pythonhosted.org/packages/f3/94/43af62df1f8986043e99d456713b0d20b93d97b47ffcb3b4ae082bfbea37/python-cyborgclient-2.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 12:53:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "python-cyborgclient"
}
JSON