The Official DocuSign Python Client

PyPI module that wraps the DocuSign API

Documentation about the DocuSign API

Requirements

• Python 2.7 (3.6+ recommended)
• Free Developer Sandbox

Compatibility

• Python 2.7+

Note

This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the Developer Center, follow the installation instructions below.

Installation

Path Setup:

1. Locate your Python installation, also referred to as a site-packages folder. This folder is usually labeled in a format of Python{VersionNumber}.

Examples:

• Unix/Linux: /usr/lib/python2.7
• Mac: /Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7
• Windows: C:\Users{username}\AppData\Local\Programs\Python\Python37

1. Add the path to your Python folder as an environment variable.

Unix/Linux:

• Type the following command into your console:
  export PYTHONPATH = "${PYTHONPATH}:.:/path/to/site-packages"
• Optionally, you can add this command to your system profile, which will run the command each time Python is launched.

Windows:

1. Open the Windows Control Panel.
2. Under the System and Security category, open the System
3. Select Advanced System Settings to open the System Properties dialog box.
4. On the Advanced tab, select the Environmental Variables button at the lower-right corner.
   1. Check if PYTHONPATH has been added as a system variable.
   2. If it has not, select New to add it. The variable you add is the path to the site-packages

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.

Install via PIP:

1. In your command console, type: pip install docusign-esign

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.

Dependencies

This client has the following external dependencies:

• certifi v14.05.14+
• six v1.8.0
• python_dateutil v2.5.3+
• setuptools v21.0.0+
• urllib3 v1.15.1+
• jwcrypto v0.4.2+
• py-oauth2 v0.0.10+

Code Examples

Launchers

DocuSign provides a sample application referred to as a Launcher. The Launcher contains a set of 14 common use cases and associated source files. These examples use DocuSign's Authorization Code Grant flow.

Proof-of-concept applications

If your goal is to create a proof of concept application, DocuSign provides a set of Quick Start examples. The Quick Start examples are meant to be used with DocuSign's OAuth Token Generator, which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.

OAuth Implementations

For details regarding which type of OAuth grant will work best for your DocuSign integration, see the REST API Authentication Overview guide located on the DocuSign Developer Center.

For security purposes, DocuSign recommends using the Authorization Code Grant flow.

There are other use-case scenarios, such as single-page applications (SPA) that use Cross-Origin Resource Sharing (CORS), or where there may not be a user to interact with your Service Account. For these use cases, DocuSign also supports JWT and Implicit grants. For code examples, see the links below:

• JWT (JSON Web Token)
• Implicit Grant (coming soon)

Support

Log issues against this client through GitHub. We also have an active developer community on Stack Overflow.

License

The DocuSign Python Client is licensed under the MIT License.