Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
include LICENSE README.rst
recursive-include solidfire *
recursive-exclude solidfire *.pyc
include MANIFEST.in
include MANIFEST.in
include python_version.json
Binary file added NetAppElementPythonSDKReleaseNotes1_7.pdf
Binary file not shown.
Binary file removed NetApp_SolidFire_Python_SDK_Release_Notes.pdf
Binary file not shown.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![sf-python-logo](https://raw.githubusercontent.com/solidfire/solidfire-sdk-python/master/img/python-50.png) SolidFire Python SDK v1.5
![sf-python-logo](https://raw.githubusercontent.com/solidfire/solidfire-sdk-python/master/img/python-50.png) SolidFire Python SDK v1.7

Python SDK library for interacting with SolidFire Element API

Expand All @@ -23,7 +23,7 @@ Compatibility

| Component | Version |
|:-------------------------|:--------------|
| SolidFire Element OS | 7.0 - 10.0 |
| SolidFire Element OS | 10.0 - 12.2 |

Getting Help
------------
Expand All @@ -37,11 +37,8 @@ new features and capabilities.
Documentation
-------------

[Latest Docs](http://solidfire-sdk-python.readthedocs.io)

[Release
Notes](https://github.com/solidfire/solidfire-sdk-python/blob/master/NetApp_SolidFire_Python_SDK_Release_Notes.pdf)

Notes](NetAppElementPythonSDKReleaseNotes1_7.pdf)

Installation
------------
Expand Down Expand Up @@ -122,13 +119,15 @@ account from the add\_account\_result object.
### More examples using the Python SDK

from solidfire.factory import ElementFactory
from solidfire.models import *

# Create connection to SF Cluster
sfe = ElementFactory.create("ip-address-of-cluster", "username", "password")

# --------- EXAMPLE 1 - CREATE AN ACCOUNT -----------
# Send the request with required parameters and gather the result
add_account_result = sfe.add_account(username="example-account")
add_account_result = sfe.add_account(username="example-account",
initiator_secret=CHAPSecret(secret="asdfghjkl"))
# Pull the account ID from the result object
account_id = add_account_result.account_id

Expand Down Expand Up @@ -179,18 +178,18 @@ unreachable):

from solidfire.factory import ElementFactory
sfe = ElementFactory.create("ip-address-of-cluster", "username", "password")
sfe.timeout(600)
sfe.connect_timeout(600)

Read timeout (useful for extending time for a service call to return):

from solidfire.factory import ElementFactory
sfe = ElementFactory.create("ip-address-of-cluster", "username", "password")
sfe.read_timeout(600)
sfe.timeout(600)

**License**
-----------

Copyright © 2016, 2017 NetApp, Inc. All rights reserved.
Copyright © 2020, 2021 NetApp, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
Expand Down
13 changes: 5 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Python SDK library for interacting with SolidFire Element API
Current Release
---------------

Version 1.5.0.87
Version 1.7.0.124

Description
-----------
Expand All @@ -26,7 +26,7 @@ Compatibility
+------------------------+---------------+
| Component | Version |
+========================+===============+
| SolidFire Element OS | 7.0 - 10.0 |
| SolidFire Element OS | 10.0 - 12.2 |
+------------------------+---------------+

Getting Help
Expand All @@ -40,10 +40,8 @@ helps us focus our efforts on new features and capabilities.
Documentation
-------------

`Latest Docs <http://solidfire-sdk-python.readthedocs.io/>`__

`Release
Notes <https://github.com/solidfire/solidfire-sdk-python/blob/master/NetApp_SolidFire_Python_SDK_Release_Notes.pdf>`__
Notes <NetAppElementPythonSDKReleaseNotes1_7.pdf>`__

Installation
------------
Expand Down Expand Up @@ -203,7 +201,7 @@ Read timeout (useful for extending time for a service call to return):
**License**
-----------

Copyright © 2016, 2017 NetApp, Inc. All rights reserved.
Copyright © 2020, 2021 NetApp, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
Expand All @@ -227,5 +225,4 @@ limitations under the License.
.. |downloads| image:: https://img.shields.io/pypi/dm/solidfire-sdk-python.svg
:target: https://pypi.python.org/pypi/solidfire-sdk-python/
.. |license| image:: https://img.shields.io/pypi/l/solidfire-sdk-python.svg
:target: https://pypi.python.org/pypi/solidfire-sdk-python/

:target: https://pypi.python.org/pypi/solidfire-sdk-python/
6 changes: 3 additions & 3 deletions descriptor_version.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"major": 1,
"version": "1.5.0.36",
"build": 36,
"minor": 5,
"version": "1.7.0.0",
"build": 0,
"minor": 7,
"patch": 0
}
4 changes: 4 additions & 0 deletions docs/_static/solidfire.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dl.attribute {
visibility: hidden;
display: none;
}
18 changes: 12 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import sphinx_rtd_theme
import os
import sys
import os
import json

sys.path.insert(0, '../..')
sys.path.insert(0, os.path.abspath('..'))

extensions = [
'sphinx.ext.autodoc',
Expand All @@ -16,18 +17,23 @@
source_suffix = '.rst'
master_doc = 'index'
project = 'solidfire-sdk-python'
copyright = '2014-2017, NetApp, Inc. All Rights Reserved.'
author = 'Adam Haid'
version = '1.5.0.87'
release = '1.5.0.87'
copyright = '2014-2020, NetApp, Inc. All Rights Reserved.'
language = 'en'
author = 'NetApp'

exclude_patterns = ['_build']
pygments_style = 'sphinx'
todo_include_todos = True
autoclass_content = 'both'
seen_element = False

with open('../python_version.json') as versionfile:
versioninfo = json.load(versionfile)
version = release = versioninfo['version']

def setup(app):
app.add_stylesheet("solidfire.css")


html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
Expand Down
Loading