{ "info": { "author": "Adam Haid, Ariel Hoffman, Joel Arthur", "author_email": "adam.haid@netapp.com, ariel.hoffman@netapp.com, joel.arthur@netapp.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Intended Audience :: Information Technology", "Intended Audience :: System Administrators", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Libraries :: Application Frameworks", "Topic :: System :: Systems Administration", "Topic :: Utilities" ], "description": "|sf-python-logo| SolidFire Python SDK\n=====================================\n\nPython SDK library for interacting with SolidFire Element API\n\n|pypy| |python| |format| |downloads| |license| |build|\n\nCurrent Release\n---------------\n\nVersion 1.5.0.87\n\nDescription\n-----------\n\nThe SolidFire Python SDK is a collection of libraries that facilitate\nintegration and orchestration between proprietary systems and\nthird-party applications. The Python SDK allows developers to deeply\nintegrate SolidFire system API with the Python programming language. The\nSolidFire Python SDK reduces the amount of additional coding time\nrequired for integration.\n\nCompatibility\n-------------\n\n+------------------------+---------------+\n| Component | Version |\n+========================+===============+\n| SolidFire Element OS | 7.0 - 10.0 |\n+------------------------+---------------+\n\nGetting Help\n------------\n\nIf you have any questions or comments about this product, contact\nng-sf-host-integrations-sdk@netapp.com or reach out to the online\ndeveloper community at `ThePub `__. Your feedback\nhelps us focus our efforts on new features and capabilities.\n\nDocumentation\n-------------\n\n`Latest Docs `__\n\n`Release\nNotes `__\n\nInstallation\n------------\n\n**From PyPI**\n\n::\n\n pip install solidfire-sdk-python\n\n**From Source**\n\n*Note*: It is recommended using\n`virtualenv `__ for isolating the\npython environment to only the required libraries.\n\nAlternatively, for development purposes or to inspect the source, the\nfollowing will work:\n\n::\n\n git clone git@github.com:solidfire/solidfire-sdk-python.git \n cd solidfire-sdk-python\n git checkout develop\n pip install -e \".[dev, test, docs, release]\"\n python setup.py install\n\nThen append the location of this directory to the ``PYTHONPATH``\nenvironment variable to use the SDK in other python scripts:\n\n::\n\n export PYTHONPATH=$PYTHONPATH:/path/to/sf-python-sdk/\n\nThat's it -- you are ready to start interacting with your SolidFire\ncluster using Python!\n\nExamples\n--------\n\nStep 1 - Build an `Element `__ object using the factory\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis is the preferred way to construct the\n`Element `__\nobject. The factory will make a call to the SolidFire cluster using the\ncredentials supplied to test the connection. It will also set the\nversion to communicate with based on the highest number supported by the\nSDK and Element OS. Optionally, you can choose to set the version\nmanually and whether or not to verify SSL. Read more about it in the\n`ElementFactory `__ documentation.\n\n.. code-block:: python\n\n from solidfire.factory import ElementFactory\n\n # Use ElementFactory to get a SolidFireElement object.\n sfe = ElementFactory.create(\"ip-address-of-cluster\", \"username\", \"password\")\n\nStep 2 - Call the API method and retrieve the result\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAll service methods in SolidFireElement call API endpoints and they all\nreturn result objects. The naming convention is :code:`[method_name]_result`.\nFor example, :code:`list_accounts` returns a :code:`list_accounts_result` object\nwhich has a property called :code:`accounts` that can be iterated.\n\nThis example sends a request to list accounts then pulls the first account\nfrom the :code:`add_account_result` object.\n\n.. code-block:: python\n\n # Send the request and wait for the result then pull the AccountID\n list_accounts_result = sfe.list_accounts()\n account = list_accounts_result.accounts[0]; \n\nMore examples using the Python SDK\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n from solidfire.factory import ElementFactory\n\n # Create connection to SF Cluster\n sfe = ElementFactory.create(\"ip-address-of-cluster\", \"username\", \"password\")\n\n # --------- EXAMPLE 1 - CREATE AN ACCOUNT -----------\n # Send the request with required parameters and gather the result\n add_account_result = sfe.add_account(username=\"example-account\")\n # Pull the account ID from the result object\n account_id = add_account_result.account_id\n\n # --------- EXAMPLE 2 - CREATE A VOLUME -------------\n # Send the request with required parameters and gather the result\n create_volume_result = sfe.create_volume(name=\"example-volume\",\n account_id=account_id,\n total_size=1000000000,\n enable512e=False)\n # Pull the VolumeID off the result object\n volume_id = create_volume_result.volume_id\n\n # --------- EXAMPLE 3 - LIST ONE VOLUME FOR AN ACCOUNT -------------\n # Send the request with desired parameters and pull the first volume in the\n # result\n volume = sfe.list_volumes(accounts=[account_id], limit=1).volumes[0]\n # pull the iqn from the volume\n iqn = volume.iqn\n\n # --------- EXAMPLE 3 - MODIFY A VOLUME -------------\n # Send the request with the desired parameters\n sfe.modify_volume(volume_id=volume_id, total_size=2000000000)\n\nMore Examples\n-------------\n\n\nMore specific examples are available `here `__\n\n\nLogging\n-------\n\nTo configure logging responses, execute the following:\n\n.. code-block:: python\n\n import logging\n from solidfire import common\n common.setLogLevel(logging.DEBUG)\n\nTo access the logger for the Element instance:\n\n.. code-block:: python\n\n from solidfire.common import LOG\n\nTimeouts\n--------\n\nConnection timeout (useful for failing fast when a host becomes\nunreachable):\n\n.. code-block:: python\n\n from solidfire.factory import ElementFactory\n sfe = ElementFactory.create(\"ip-address-of-cluster\", \"username\", \"password\")\n sfe.timeout(600)\n\nRead timeout (useful for extending time for a service call to return):\n\n.. code-block:: python\n\n from solidfire.factory import ElementFactory\n sfe = ElementFactory.create(\"ip-address-of-cluster\", \"username\", \"password\")\n sf.read_timeout(600)\n\n**License**\n-----------\n\nCopyright \u00a9 2016, 2017 NetApp, Inc. All rights reserved.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may\nnot use this file except in compliance with the License. You may obtain\na copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n.. |sf-python-logo| image:: https://raw.githubusercontent.com/solidfire/solidfire-sdk-python/release1.1/img/python-50.png\n.. |pypy| image:: https://img.shields.io/pypi/v/solidfire-sdk-python.svg\n :target: https://badge.fury.io/py/solidfire-sdk-python\n.. |python| image:: https://img.shields.io/pypi/pyversions/solidfire-sdk-python.svg\n :target: https://pypi.python.org/pypi/solidfire-sdk-python/\n.. |format| image:: https://img.shields.io/pypi/format/solidfire-sdk-python.svg\n :target: https://pypi.python.org/pypi/solidfire-sdk-python/\n.. |downloads| image:: https://img.shields.io/pypi/dm/solidfire-sdk-python.svg\n :target: https://pypi.python.org/pypi/solidfire-sdk-python/\n.. |license| image:: https://img.shields.io/pypi/l/solidfire-sdk-python.svg\n :target: https://pypi.python.org/pypi/solidfire-sdk-python/\n.. |build| image:: https://img.shields.io/travis/solidfire/solidfire-sdk-python/release/1.0.0.svg\n :target: https://pypi.python.org/pypi/solidfire-sdk-python/\n\n\n\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/solidfire/solidfire-sdk-python", "keywords": "solidfire nas iscsi fibre channel storage api sdk", "license": "Apache2", "maintainer": "", "maintainer_email": "", "name": "solidfire-sdk-python", "package_url": "https://pypi.org/project/solidfire-sdk-python/", "platform": "", "project_url": "https://pypi.org/project/solidfire-sdk-python/", "project_urls": { "Homepage": "https://github.com/solidfire/solidfire-sdk-python" }, "release_url": "https://pypi.org/project/solidfire-sdk-python/1.5.0.87/", "requires_dist": [ "enum34 (>=1.1.6)", "future (>=0.15.2)", "requests (>=2.9.1)", "setuptools (>=19.2)", "check-manifest; extra == 'dev'", "Sphinx (>=1.3.5); extra == 'docs'", "sphinx-rtd-theme (>=0.1.9); extra == 'docs'", "twine (>=1.6.5); extra == 'release'", "coverage; extra == 'test'", "pyhamcrest (>=1.8.5); extra == 'test'", "pytest (>=2.8.7); extra == 'test'", "pytest-flake8 (>=0.1); extra == 'test'" ], "requires_python": "", "summary": "SolidFire Python SDK", "version": "1.5.0.87" }, "last_serial": 5673881, "releases": { "1.0.0.104": [ { "comment_text": "", "digests": { "md5": "7a1a5c728faf7ba3e7ca96d48ab30caf", "sha256": "abae2bd41ea74c0c8b7f337ce984a18be26013919cecce68af22ffb69be8a09b" }, "downloads": -1, "filename": "solidfire_sdk_python-1.0.0.104-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7a1a5c728faf7ba3e7ca96d48ab30caf", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 35147, "upload_time": "2016-04-06T16:31:28", "url": "https://files.pythonhosted.org/packages/33/e3/7bc4fc731c4c1e1c3f58666b84273c5258452390b51ce0fb6a438098b75c/solidfire_sdk_python-1.0.0.104-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1cee899e7935a1cbf2b2630535ceccc7", "sha256": "d82a60b118615f3d7b61d75d2d919b28ed2436223809b9182914b59fa1139597" }, "downloads": -1, "filename": "solidfire-sdk-python-1.0.0.104.tar.gz", "has_sig": false, "md5_digest": "1cee899e7935a1cbf2b2630535ceccc7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 36035, "upload_time": "2016-04-06T16:31:37", "url": "https://files.pythonhosted.org/packages/d0/d4/4cc9bcf3409cf076353762f37c33c9d847aa29e328f61de4ffb1935b83b3/solidfire-sdk-python-1.0.0.104.tar.gz" } ], "1.1.0.92": [ { "comment_text": "SolidFire Python SDK Wheel v1.1.0.92", "digests": { "md5": "9af92fda89e2cfcd058688f2fbbc5ba8", "sha256": "f5345bb2ec8c1389c039a64099e833590c473962bcc4d77a46d5ee1d39711f4d" }, "downloads": -1, "filename": "solidfire_sdk_python-1.1.0.92--py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9af92fda89e2cfcd058688f2fbbc5ba8", "packagetype": "bdist_wheel", "python_version": "any", "requires_python": null, "size": 91894, "upload_time": "2016-09-20T18:44:06", "url": "https://files.pythonhosted.org/packages/49/b6/d826952bf187df0efba262d7b1d0153033d25a00c640314bfeda33a76645/solidfire_sdk_python-1.1.0.92--py2.py3-none-any.whl" }, { "comment_text": "SolidFire Python SDK Source v1.1.0.92", "digests": { "md5": "2f62ce20b77b403731399f95b550c4e2", "sha256": "e7a3f096055d0e0f671a774d3b01aba0d5d8a043c42ca926ccb76d534445e901" }, "downloads": -1, "filename": "solidfire-sdk-python-1.1.0.92.tar.gz", "has_sig": false, "md5_digest": "2f62ce20b77b403731399f95b550c4e2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 83756, "upload_time": "2016-09-20T18:39:21", "url": "https://files.pythonhosted.org/packages/d0/48/e24110ab83d390098f4ffda8eaafea1a814085c1d7139f1016a18fbafcc4/solidfire-sdk-python-1.1.0.92.tar.gz" } ], "1.2.0.108": [ { "comment_text": "", "digests": { "md5": "765a67cdf89b8c461dd650ad8699e304", "sha256": "590704760a882ef8b16d888c125db6d0fe9ff8e1040f08c2f5a704179c9366bd" }, "downloads": -1, "filename": "solidfire_sdk_python-1.2.0.108-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "765a67cdf89b8c461dd650ad8699e304", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 223982, "upload_time": "2017-01-25T20:31:07", "url": "https://files.pythonhosted.org/packages/3a/5d/0b3c2684f0825ae60d733936619dcb71a6f9a1bba073ccd21bd6607c085d/solidfire_sdk_python-1.2.0.108-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b4afdb2581dff25dd9fa8d1958e92537", "sha256": "e01eabd01fea9b66e6953f00c5a6deb1800bffe2561ba8dda744841d497726f9" }, "downloads": -1, "filename": "solidfire_sdk_python-1.4.0.271-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b4afdb2581dff25dd9fa8d1958e92537", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 159487, "upload_time": "2017-05-25T18:36:25", "url": "https://files.pythonhosted.org/packages/28/7f/cd59cdf250b7bc56ae278551efc0ecfb850d903c705fd87716013807173b/solidfire_sdk_python-1.4.0.271-py2.py3-none-any.whl" } ], "1.4.0.271": [], "1.5.0.87": [ { "comment_text": "", "digests": { "md5": "ef524f0fd279884d619b1571a69050ea", "sha256": "8b84c0062d5e03be9979982cee9fe45666cf3efac241f4d4471b03bb15a11ff1" }, "downloads": -1, "filename": "solidfire-sdk-python-1.5.0.87-1.tar.gz", "has_sig": false, "md5_digest": "ef524f0fd279884d619b1571a69050ea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 163505, "upload_time": "2017-11-29T17:50:51", "url": "https://files.pythonhosted.org/packages/e0/bb/29138f9a7816d608bfbce35ddbea51927a68ace2ca6582bdbe4c2e00a382/solidfire-sdk-python-1.5.0.87-1.tar.gz" }, { "comment_text": "", "digests": { "md5": "aa1d9438a299b72ceaab8d3bafe1f796", "sha256": "40fe41391e1c6d835c4e03cbd5373a17ef4f3d457108267e7f9d0b2c829dde9a" }, "downloads": -1, "filename": "solidfire_sdk_python-1.5.0.87-py2.py3-sf-any.whl", "has_sig": false, "md5_digest": "aa1d9438a299b72ceaab8d3bafe1f796", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 168946, "upload_time": "2017-11-29T17:50:06", "url": "https://files.pythonhosted.org/packages/01/79/623fc1013f6839490b9be410a5e1250e0023d84846411b0bd22bd93f975b/solidfire_sdk_python-1.5.0.87-py2.py3-sf-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ef524f0fd279884d619b1571a69050ea", "sha256": "8b84c0062d5e03be9979982cee9fe45666cf3efac241f4d4471b03bb15a11ff1" }, "downloads": -1, "filename": "solidfire-sdk-python-1.5.0.87-1.tar.gz", "has_sig": false, "md5_digest": "ef524f0fd279884d619b1571a69050ea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 163505, "upload_time": "2017-11-29T17:50:51", "url": "https://files.pythonhosted.org/packages/e0/bb/29138f9a7816d608bfbce35ddbea51927a68ace2ca6582bdbe4c2e00a382/solidfire-sdk-python-1.5.0.87-1.tar.gz" }, { "comment_text": "", "digests": { "md5": "aa1d9438a299b72ceaab8d3bafe1f796", "sha256": "40fe41391e1c6d835c4e03cbd5373a17ef4f3d457108267e7f9d0b2c829dde9a" }, "downloads": -1, "filename": "solidfire_sdk_python-1.5.0.87-py2.py3-sf-any.whl", "has_sig": false, "md5_digest": "aa1d9438a299b72ceaab8d3bafe1f796", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 168946, "upload_time": "2017-11-29T17:50:06", "url": "https://files.pythonhosted.org/packages/01/79/623fc1013f6839490b9be410a5e1250e0023d84846411b0bd22bd93f975b/solidfire_sdk_python-1.5.0.87-py2.py3-sf-any.whl" } ] }