Skip to content

Latest commit

 

History

History
127 lines (104 loc) · 6.71 KB

README.md

File metadata and controls

127 lines (104 loc) · 6.71 KB
Raw

The Official Docusign eSignature Python Client SDK

PyPI version

The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.

Table of Contents

Introduction

Integrate eSignatures into your application in minutes. The secure and award-winning Docusign eSignature API makes requesting signatures, automating forms, and tracking documents directly from your app easy.

Installation

This client 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.

Version Information

  • API version: v2.1
  • Latest SDK version: 5.0.0rc2

Requirements

Compatibility

  • Python 2.7+

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.

SDK 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+
  • PyJWT v2.0.0+
  • cryptography v2.5+

API Reference

You can refer to the API reference here.

Code examples

Explore our GitHub repository for the Launcher, a self-executing package housing code examples for the eSignature Python SDK. This package showcases several common use cases and their respective source files. Additionally, you can download a version preconfigured for your Docusign developer account from Quickstart. These examples support both the Authorization Code Grant and 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.

Changelog

You can refer to the complete changelog here.

Support

Log issues against this client SDK through GitHub. You can also reach out to us through Docusign Community and Stack Overflow.

License

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

Additional resources