|
1 | | -# docusign-admin-python-client |
| 1 | +# The Official DocuSign OrgAdmin Python Client |
| 2 | + |
| 3 | +[![PyPI version][pypi-image]][pypi-url] |
| 4 | +<!--[![PyPI downloads][downloads-image]][downloads-url]--> |
| 5 | +[![Build status][travis-image]][travis-url] |
| 6 | + |
| 7 | +[PyPI module](https://pypi.python.org/pypi/docusign_orgadmin) that wraps the <a href="https://www.docusign.com/products/orgadmin-for-real-estate">DocuSign OrgAdmin</a> API |
| 8 | + |
| 9 | +[Documentation about the DocuSign OrgAdmin API](https://developers.docusign.com/) |
| 10 | + |
| 11 | +## Requirements |
| 12 | + |
| 13 | +- Python 2.7 (3.7+ recommended) |
| 14 | +- Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531) |
| 15 | + |
| 16 | +## Compatibility |
| 17 | + |
| 18 | +- Python 2.7+ |
| 19 | + |
| 20 | +## Installation |
| 21 | + |
| 22 | +### Path Setup: |
| 23 | + |
| 24 | +1. Locate your Python installation, also referred to as a **site-packages** folder. This folder is usually labeled in a format of Python{VersionNumber}. |
| 25 | + |
| 26 | +**Examples:** |
| 27 | + |
| 28 | +- **Unix/Linux:** /usr/lib/python2.7 |
| 29 | +- **Mac:** /Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7 |
| 30 | +- **Windows:** C:\Users\{username}\AppData\Local\Programs\Python\Python37 |
| 31 | + |
| 32 | +1. Add the path to your Python folder as an environment variable. |
| 33 | + |
| 34 | +**Unix/Linux:** |
| 35 | + |
| 36 | +- Type the following command into your console: |
| 37 | + **export PYTHONPATH = "${PYTHONPATH}:.:/path/to/site-packages"** |
| 38 | +- Optionally, you can add this command to your system profile, which will run the command each time Python is launched. |
| 39 | + |
| 40 | +**Windows:** |
| 41 | + |
| 42 | +<ol> |
| 43 | + <li>Open the Windows <b>Control Panel.</b></li> |
| 44 | + <li>Under the System and Security category, open the <b>System</b></li> |
| 45 | + <li>Select <b>Advanced System Settings</b> to open the <b>System Properties</b> dialog box.</li> |
| 46 | + <li>On the <b>Advanced</b> tab, select the <b>Environmental Variables</b> button at the lower-right corner. |
| 47 | + <ol style="list-style-type: lower-alpha"> |
| 48 | + <li>Check if <b>PYTHONPATH</b> has been added as a <b>system variable.</b></li> |
| 49 | + <li>If it has not, select <b>New</b> to add it. The variable you add is the path to the <b>site-packages</b></li> |
| 50 | + </ol> |
| 51 | + </li> |
| 52 | +</ol> |
| 53 | + |
| 54 | +**Note:** If you are still unable to reference python or pip via your command console,you can also add the path to the site-packages folder to the built-in environment variable labeled **Path** , which will take effect the next time you start your machine. |
| 55 | + |
| 56 | +### Install via PIP: |
| 57 | + |
| 58 | +1. In your command console, type: |
| 59 | +pip install docusign-orgadmin |
| 60 | + |
| 61 | +Note: This may require the command console be elevated. You can accomplish this via sudoin Unix/Linux, or by running the command console as an administrator in Windows. |
| 62 | + |
| 63 | +## Dependencies |
| 64 | + |
| 65 | +This client has the following external dependencies: |
| 66 | + |
| 67 | +- certifi v14.05.14+ |
| 68 | +- six v1.8.0+ |
| 69 | +- python\_dateutil v2.5.3+ |
| 70 | +- setuptools v21.0.0+ |
| 71 | +- urllib3 v1.15.1+ |
| 72 | +- jwcrypto v0.4.2+ |
| 73 | +- py-oauth2 v0.0.10+ |
| 74 | + |
| 75 | + |
| 76 | +## Support |
| 77 | + |
| 78 | +Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi). |
| 79 | + |
| 80 | +## License |
| 81 | + |
| 82 | +The DocuSign Python Client is licensed under the [MIT License](https://github.com/docusign/docusign-python-client/blob/master/LICENSE). |
| 83 | + |
| 84 | + |
| 85 | +[pypi-image]: https://img.shields.io/pypi/v/docusign_orgadmin.svg?style=flat |
| 86 | +[pypi-url]: https://pypi.python.org/pypi/docusign_orgadmin |
| 87 | +[downloads-image]: https://img.shields.io/pypi/dm/docusign_orgadmin.svg?style=flat |
| 88 | +[downloads-url]: https://pypi.python.org/pypi/docusign_orgadmin |
| 89 | +[travis-image]: https://img.shields.io/travis/docusign/docusign-orgadmin-python-client.svg?style=flat |
| 90 | +[travis-url]: https://travis-ci.org/docusign/docusign-orgadmin-python-client |
0 commit comments