{ "info": { "author": "", "author_email": "", "bugtrack_url": null, "classifiers": [], "description": "|Build Status| |codecov|\n\nOpenStack Info\n==============\n\n*Gets information about what is in an OpenStack tenant.*\n\nInstallation\n------------\n\nPrerequisites: - python >= 3.6\n\nThe tool can be installed from PyPi:\n\n.. code:: bash\n\n pip install openstackinfo\n\nBleeding edge versions can be installed directly from GitHub:\n\n.. code:: bash\n\n git clone https://github.com/wtsi-hgi/openstack-info.git\n cd openstack-tenant-cleaner\n python setup.py install\n\nor using pip:\n\n.. code:: bash\n\n pip install git+https://github.com/wtsi-hgi/openstack-info.git@master#egg=openstackinfo\n\nUsage\n-----\n\nCLI\n~~~\n\nSet environment variables:\n\n.. code:: bash\n\n export OS_USERNAME=user\n export OS_TENANT_NAME=tenant\n export OS_AUTH_URL=http://example.com:5000/v2.0/\n export OS_PASSWORD=password\n\nThen call:\n\n.. code:: bash\n\n openstackinfo\n\nThe available options can be found with ``openstackinfo -h``:\n\n::\n\n usage: openstackinfo [-h] [-i {type,id}] [--max-connections MAX_CONNECTIONS]\n [--retries RETRIES] [--retry-wait RETRY_WAIT]\n [--retry-wait-multiplier RETRY_WAIT_MULTIPLIER]\n\n Openstack tenant information retriever\n\n optional arguments:\n -h, --help show this help message and exit\n -i {type,id}, --index {type,id}\n What the OpenStack information should be index by\n (default: type)\n --max-connections MAX_CONNECTIONS\n Maximum number of simultaneous connections to make to\n OpenStack. Configured automatically if not set\n (default: None)\n --retries RETRIES Number of times to retry getting information about a\n particular tpye of OpenStack resource (default: 3)\n --retry-wait RETRY_WAIT\n Initial amount of time (in seconds) to wait after a\n failure before retrying (default: 1.0)\n --retry-wait-multiplier RETRY_WAIT_MULTIPLIER\n Multiplier that is applied to the wait time after each\n failure. e.g. An initial wait time of 1.0s, a wait\n multiplier of 5.0, and a maximum of 3 retries will\n result in the waits between retries of [1.0s, 5.0s,\n 25.0s] (default: 5.0)\n --retry-wait-deviation RETRY_WAIT_DEVIATION\n To minimise collisions, the wait time before retrying\n a request is randomised to plus or minus the value of\n this parameter as a percentage of the total wait time.\n e.g. A wait time of 1.0s and max deviation percentage\n of 10.0 will result in an actual wait between 0.9s and\n 1.1s (default: 10.0)\n\nPython\n~~~~~~\n\n.. code:: python\n\n from openstackinfo.retriever.models import Credentials\n from openstackinfo.retriever.retrievers import ShadeInformationRetriever\n from openstackinfo.helpers import get_information, RunConfiguration\n from openstackinfo.indexers import InformationIndexerByType\n\n retriever = ShadeInformationRetriever(credentials=Credentials(username, password, auth_url, tenant))\n configuration = RunConfiguration(retriever=retriever, indexer=InformationIndexerByType)\n openstack_info = get_information(configuration)\n\nAlternatives\n------------\n\n- `shade `__ (underlying library:\n no CLI, no re-indexing).\n- `Nova\n CLI `__\n (does not return JSON).\n- `Openstack\n CLI `__\n (does not return server metadata).\n\n.. |Build Status| image:: https://travis-ci.org/wtsi-hgi/openstack-info.svg?branch=master\n :target: https://travis-ci.org/wtsi-hgi/openstack-info\n.. |codecov| image:: https://codecov.io/gh/wtsi-hgi/openstack-info/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/wtsi-hgi/openstack-info\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/wtsi-hgi/openstack-info", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "openstackinfo", "package_url": "https://pypi.org/project/openstackinfo/", "platform": "", "project_url": "https://pypi.org/project/openstackinfo/", "project_urls": { "Homepage": "https://github.com/wtsi-hgi/openstack-info" }, "release_url": "https://pypi.org/project/openstackinfo/5.5.0/", "requires_dist": null, "requires_python": "", "summary": "Gets information about what is in an OpenStack tenant", "version": "5.5.0" }, "last_serial": 3239641, "releases": { "5.4.0": [ { "comment_text": "", "digests": { "md5": "3dc80c1f8e597a4bf46344879445a285", "sha256": "f27a314c8486b9e2dfff5deb63a0115ac53ba68729d0f28040efe860d8a7210f" }, "downloads": -1, "filename": "openstackinfo-5.4.0.tar.gz", "has_sig": false, "md5_digest": "3dc80c1f8e597a4bf46344879445a285", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10543, "upload_time": "2017-10-09T16:22:29", "url": "https://files.pythonhosted.org/packages/b8/91/311540f2f603e976dc1659052f7469ec1e2ffe09e3d0789807c0d26d81fb/openstackinfo-5.4.0.tar.gz" } ], "5.5.0": [ { "comment_text": "", "digests": { "md5": "456940c85a7a1d1b4d6656c31eb348e0", "sha256": "524e8664521e612c515eb328b505ebef86b4927c12dac80a20878d9dcc81779e" }, "downloads": -1, "filename": "openstackinfo-5.5.0.tar.gz", "has_sig": false, "md5_digest": "456940c85a7a1d1b4d6656c31eb348e0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11483, "upload_time": "2017-10-10T14:55:34", "url": "https://files.pythonhosted.org/packages/d3/f2/763f0140719bc7840d60d6567606ed906aff5310b353fed09b59120f7b67/openstackinfo-5.5.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "456940c85a7a1d1b4d6656c31eb348e0", "sha256": "524e8664521e612c515eb328b505ebef86b4927c12dac80a20878d9dcc81779e" }, "downloads": -1, "filename": "openstackinfo-5.5.0.tar.gz", "has_sig": false, "md5_digest": "456940c85a7a1d1b4d6656c31eb348e0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11483, "upload_time": "2017-10-10T14:55:34", "url": "https://files.pythonhosted.org/packages/d3/f2/763f0140719bc7840d60d6567606ed906aff5310b353fed09b59120f7b67/openstackinfo-5.5.0.tar.gz" } ] }