========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/python-manilaclient.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
Python bindings to the OpenStack Manila API
===========================================
.. only: html
.. image:: https://img.shields.io/pypi/v/python-manilaclient.svg
:target: https://pypi.org/project/python-manilaclient/
:alt: Latest Version
This is a client for the OpenStack Manila API. There's a Python API (the
``manilaclient`` module), and a command-line script (``manila``). Each
implements 100% of the OpenStack Manila API.
See the `OpenStack CLI guide`_ for information on how to use the ``manila``
command-line tool. You may also want to look at the
`OpenStack API documentation`_.
.. _OpenStack CLI Guide: https://docs.openstack.org/python-openstackclient/latest/cli/
.. _OpenStack API documentation: https://docs.openstack.org/api/
The project is hosted on `Launchpad`_, where bugs can be filed. The code is
hosted on `Github`_. Patches must be submitted using `Gerrit`_, *not* Github
pull requests.
.. _Github: https://github.com/openstack/python-manilaclient
.. _Launchpad: https://launchpad.net/python-manilaclient
.. _Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow
This code is a fork of `Cinderclient`_ of Grizzly release and then it was
developed separately. Cinderclient 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-manilaclient is licensed under the Apache License like the rest of
OpenStack.
.. _Cinderclient: https://github.com/openstack/python-cinderclient
__ https://github.com/jacobian/python-cloudservers
.. contents:: Contents:
:local:
Command-line API
----------------
Installing this package gets you a shell command, ``manila``, 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=foouser
export OS_PASSWORD=barpass
export OS_TENANT_NAME=fooproject
You will also need to define the authentication url either with param
``--os-auth-url`` or as an environment variable::
export OS_AUTH_URL=http://example.com:5000/v2.0/
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
``manila help``, see ``manila help COMMAND`` for help on a specific command.
Python API
----------
There's also a complete Python API, but it has not yet been documented.
Quick-start using keystone::
# use v2.0 auth with http://example.com:5000/v2.0/
>>> from manilaclient.v1 import client
>>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="share")
>>> nt.shares.list()
[...]
* License: Apache License, Version 2.0
* `PyPi`_ - package installation
* `Online Documentation`_
* `Launchpad project`_ - release management
* `Blueprints`_ - feature specifications
* `Bugs`_ - issue tracking
* `Source`_
* `How to Contribute`_
* `Release Notes`_
.. _PyPi: https://pypi.org/project/python-manilaclient
.. _Online Documentation: https://docs.openstack.org/python-manilaclient/latest/
.. _Launchpad project: https://launchpad.net/python-manilaclient
.. _Blueprints: https://blueprints.launchpad.net/python-manilaclient
.. _Bugs: https://bugs.launchpad.net/python-manilaclient
.. _Source: https://opendev.org/openstack/python-manilaclient
.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html
.. _Release Notes: https://docs.openstack.org/releasenotes/python-manilaclient
Raw data
{
"_id": null,
"home_page": "https://docs.openstack.org/python-manilaclient/latest/",
"name": "python-manilaclient",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/a4/60/b9143015703487519c6bbd8ae70e6ca84a9d42361c211d9f620d4428d150/python-manilaclient-4.7.0.tar.gz",
"platform": null,
"description": "========================\nTeam and repository tags\n========================\n\n.. image:: https://governance.openstack.org/tc/badges/python-manilaclient.svg\n :target: https://governance.openstack.org/tc/reference/tags/index.html\n\n.. Change things from this point on\n\nPython bindings to the OpenStack Manila API\n===========================================\n\n.. only: html\n\n .. image:: https://img.shields.io/pypi/v/python-manilaclient.svg\n :target: https://pypi.org/project/python-manilaclient/\n :alt: Latest Version\n\nThis is a client for the OpenStack Manila API. There's a Python API (the\n``manilaclient`` module), and a command-line script (``manila``). Each\nimplements 100% of the OpenStack Manila API.\n\nSee the `OpenStack CLI guide`_ for information on how to use the ``manila``\ncommand-line tool. You may also want to look at the\n`OpenStack API documentation`_.\n\n.. _OpenStack CLI Guide: https://docs.openstack.org/python-openstackclient/latest/cli/\n.. _OpenStack API documentation: https://docs.openstack.org/api/\n\nThe project is hosted on `Launchpad`_, where bugs can be filed. The code is\nhosted on `Github`_. Patches must be submitted using `Gerrit`_, *not* Github\npull requests.\n\n.. _Github: https://github.com/openstack/python-manilaclient\n.. _Launchpad: https://launchpad.net/python-manilaclient\n.. _Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow\n\nThis code is a fork of `Cinderclient`_ of Grizzly release and then it was\ndeveloped separately. Cinderclient code is a fork of\n`Jacobian's python-cloudservers`__ If you need API support for the Rackspace\nAPI solely or the BSD license, you should use that repository.\npython-manilaclient is licensed under the Apache License like the rest of\nOpenStack.\n\n.. _Cinderclient: https://github.com/openstack/python-cinderclient\n__ https://github.com/jacobian/python-cloudservers\n\n.. contents:: Contents:\n :local:\n\nCommand-line API\n----------------\n\nInstalling this package gets you a shell command, ``manila``, 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=foouser\n export OS_PASSWORD=barpass\n export OS_TENANT_NAME=fooproject\n\nYou will also need to define the authentication url either with param\n``--os-auth-url`` or as an environment variable::\n\n export OS_AUTH_URL=http://example.com:5000/v2.0/\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``manila help``, see ``manila help COMMAND`` for help on a specific command.\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 # use v2.0 auth with http://example.com:5000/v2.0/\n >>> from manilaclient.v1 import client\n >>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type=\"share\")\n >>> nt.shares.list()\n [...]\n\n* License: Apache License, Version 2.0\n* `PyPi`_ - package installation\n* `Online Documentation`_\n* `Launchpad project`_ - release management\n* `Blueprints`_ - feature specifications\n* `Bugs`_ - issue tracking\n* `Source`_\n* `How to Contribute`_\n* `Release Notes`_\n\n.. _PyPi: https://pypi.org/project/python-manilaclient\n.. _Online Documentation: https://docs.openstack.org/python-manilaclient/latest/\n.. _Launchpad project: https://launchpad.net/python-manilaclient\n.. _Blueprints: https://blueprints.launchpad.net/python-manilaclient\n.. _Bugs: https://bugs.launchpad.net/python-manilaclient\n.. _Source: https://opendev.org/openstack/python-manilaclient\n.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html\n.. _Release Notes: https://docs.openstack.org/releasenotes/python-manilaclient\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Client library for OpenStack Manila API.",
"version": "4.7.0",
"project_urls": {
"Homepage": "https://docs.openstack.org/python-manilaclient/latest/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "30ce3e7e1c8991e70ff4dd347c9024ad0ea004dd90df19c88f5a2a4d70b0093f",
"md5": "38855c58a55f4017326966963594cc40",
"sha256": "952a5c833138ede93a6cc28c9aad9ce32dc2206d05fb25b0bd6963968eaddfba"
},
"downloads": -1,
"filename": "python_manilaclient-4.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "38855c58a55f4017326966963594cc40",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 512601,
"upload_time": "2023-11-20T07:06:34",
"upload_time_iso_8601": "2023-11-20T07:06:34.494996Z",
"url": "https://files.pythonhosted.org/packages/30/ce/3e7e1c8991e70ff4dd347c9024ad0ea004dd90df19c88f5a2a4d70b0093f/python_manilaclient-4.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a460b9143015703487519c6bbd8ae70e6ca84a9d42361c211d9f620d4428d150",
"md5": "2d338679efedf5caed79cd3f38bdbb99",
"sha256": "6e5904fa92f3650f0108702693ac8d8f3a9b04094ad9a6f5172486141fe43767"
},
"downloads": -1,
"filename": "python-manilaclient-4.7.0.tar.gz",
"has_sig": false,
"md5_digest": "2d338679efedf5caed79cd3f38bdbb99",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 380403,
"upload_time": "2023-11-20T07:06:36",
"upload_time_iso_8601": "2023-11-20T07:06:36.873669Z",
"url": "https://files.pythonhosted.org/packages/a4/60/b9143015703487519c6bbd8ae70e6ca84a9d42361c211d9f620d4428d150/python-manilaclient-4.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-20 07:06:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "python-manilaclient"
}
JSON