https://github.com/docusign/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
https://github.com/docusign/docusign-esign-python-client

digital-signature docusign docusign-api docusign-python-client docusign-rest electronic-signatures esignature sdk

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/docusign/docusign-esign-python-client
Owner: docusign
License: mit
Created: 2017-08-09T01:02:47.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2024-09-06T12:16:49.000Z (9 months ago)
Last Synced: 2025-02-23T09:32:05.727Z (3 months ago)
Topics: digital-signature, docusign, docusign-api, docusign-python-client, docusign-rest, electronic-signatures, esignature, sdk
Language: Python
Size: 21 MB
Stars: 98
Watchers: 23
Forks: 88
Open Issues: 36
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # The Official Docusign eSignature Python Client SDK

[![PyPI version][pypi-image]][pypi-url]

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

## Table of Contents

- [Introduction](#introduction)

- [Installation](#installation)

	* [Version Information](#versionInformation)

	* [Requirements](#requirements)

	* [Compatibility](#compatibility)

	* [Path setup](#pathSetup)

	* [Install via PIP](#pip)

- [Dependencies](#dependencies)

- [API Reference](#apiReference)

- [Code Examples](#codeExamples)

- [OAuth Implementations](#oauthImplementations)

- [Changelog](#changeLog)

- [Support](#support)

- [License](#license)

- [Additional Resources](#additionalResources)



## 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](https://developers.docusign.com/docs/esign-rest-api/how-to/) from the [Docusign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.



### Version Information

- **API version**: v2.1

- **Latest SDK version**: 5.0.0rc2



## Requirements

*   Python 2.7 (3.7+ recommended)

*   Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/)



## 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:**

    


      Open the Windows Control Panel.



      Under the System and Security category, open the System information panel.

      Select Advanced System Settings to open the System Properties dialog box.

      On the Advanced tab, select the Environment Variables button at the lower-right corner.

          

              Check to see whether PYTHONPATH has been added as a system variable.



              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](https://developers.docusign.com/docs/esign-rest-api/reference/).



## Code examples

Explore our GitHub repository for the [Launcher](https://github.com/docusign/code-examples-python/), 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](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples support both the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) and [JSON Web Token (JWT)](https://developers.docusign.com/platform/auth/jwt/) authentication workflows.

## OAuth implementations

For details regarding which type of OAuth grant will work best for your Docusign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [Docusign Developer Center](https://developers.docusign.com/).

For security purposes, Docusign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) flow.



## Changelog

You can refer to the complete changelog [here](https://github.com/docusign/docusign-esign-python-client/blob/master/CHANGELOG.md).



## Support

Log issues against this client SDK through GitHub. You can also reach out to us through [Docusign Community](https://community.docusign.com/developer-59) and [Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).



## License

The Docusign eSignature Python Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-esign-python-client/blob/master/LICENSE).



### Additional resources

*   [Docusign Developer Center](https://developers.docusign.com/)

*   [Docusign API on Twitter](https://twitter.com/docusignapi)

*   [Docusign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)

*   [Docusign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2)

[pypi-image]: https://img.shields.io/pypi/v/docusign_esign.svg?style=flat

[pypi-url]: https://pypi.python.org/pypi/docusign_esign

[downloads-image]: https://img.shields.io/pypi/dm/docusign_esign.svg?style=flat

[downloads-url]: https://pypi.python.org/pypi/docusign_esign

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/docusign/docusign-esign-python-client

Awesome Lists containing this project

README