pineapplehq / docusign-esign-python-client

The Official DocuSign Python Client Library used to interact with the eSign REST API. Send, sign, and approve documents using this client. https://www.docusign.com/devcenter

The Official DocuSign eSignature Python Client SDK

PyPI module

Documentation about DocuSign APIs

Requirements

• Python 2.7 (3.7+ recommended)
• Free developer account

Compatibility

• Python 2.7+

Installation

This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our code examples from the DocuSign Developer Center, you merely need to install it by following the instructions below.

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

2. Add your Python folder’s path to your system as an environment variable.
   Unix/Linux:

   1. Type the following command into your console:
      export PYTHONPATH = "${PYTHONPATH}:.:/path/to/site-packages"
   2. 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 information panel.
   3. Select Advanced System Settings to open the System Properties dialog box.
   4. On the Advanced tab, select the Environment Variables button at the lower-right corner.
      1. Check to see whether 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 folder.

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:

In your command console, type: pip install docusign-esign
Note: This may require the command console to be elevated. You can accomplish this via sudo in 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

You can find on our GitHub a self-executing package of code examples for the eSignature Python SDK, called a Launcher, that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from Quickstart. These examples can use either the Authorization Code Grant or JSON Web Token (JWT) authentication workflows.

OAuth implementations

For details regarding which type of OAuth grant will work best for your DocuSign integration, see Choose OAuth Type in the DocuSign Developer Center.

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

Support

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

License

The DocuSign eSignature Python Client SDK is licensed under the MIT License.

Additional resources

• DocuSign Developer Center
• DocuSign API on Twitter
• DocuSign For Developers on LinkedIn
• DocuSign For Developers on YouTube