You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below.
23
-
24
20
## Installation
25
-
26
-
### Path Setup:
27
-
28
-
1. Locate your Python installation, also referred to as a **site-packages** folder. This folder is usually labeled in a format of Python{VersionNumber}.
- Optionally, you can add this command to your system profile, which will run the command each time Python is launched.
43
-
44
-
**Windows:**
45
-
46
-
<ol>
47
-
<li>Open the Windows <b>Control Panel.</b></li>
48
-
<li>Under the System and Security category, open the <b>System</b></li>
49
-
<li>Select <b>Advanced System Settings</b> to open the <b>System Properties</b> dialog box.</li>
50
-
<li>On the <b>Advanced</b> tab, select the <b>Environmental Variables</b> button at the lower-right corner.
51
-
<ol style="list-style-type: lower-alpha">
52
-
<li>Check if <b>PYTHONPATH</b> has been added as a <b>system variable.</b></li>
53
-
<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>
54
-
</ol>
55
-
</li>
56
-
</ol>
57
-
58
-
**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.
21
+
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](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.
22
+
23
+
### Path setup:
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}**.
2. Optionally, you can add this command to your system profile, which will run the command each time Python is launched.
34
+
35
+
**Windows:**
36
+
<ol>
37
+
<li>Open the Windows <strong>Control Panel.</strong></li>
38
+
<li>Under the System and Security category, open the <strong>System</strong> information panel.</li>
39
+
<li>Select <strong>Advanced System Settings</strong> to open the <strong>System Properties</strong> dialog box.</li>
40
+
<li>On the <strong>Advanced</strong> tab, select the <strong>Environment Variables</strong> button at the lower-right corner.
41
+
<ol style="list-style-type: lower-alpha">
42
+
<li>Check to see whether <strong>PYTHONPATH</strong> has been added as a <strong>system variable.</strong></li>
43
+
<li>If it has not, select <strong>New</strong> to add it. The variable you add is the path to the <strong>site-packages</strong> folder.</li>
44
+
</ol>
45
+
</li>
46
+
</ol>
47
+
48
+
**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.
59
49
60
50
### Install via PIP:
61
-
62
-
1. In your command console, type:
63
-
pip install docusign-esign
64
-
65
-
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.
51
+
In your command console, type: **pip install docusign-esign**
52
+
**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.
66
53
67
54
## Dependencies
68
-
69
55
This client has the following external dependencies:
70
56
71
57
- certifi v14.05.14+
@@ -76,41 +62,29 @@ This client has the following external dependencies:
76
62
- jwcrypto v0.4.2+
77
63
- py-oauth2 v0.0.10+
78
64
79
-
## Code Examples
80
-
81
-
### Launchers
82
-
83
-
DocuSign provides a sample application code referred to as a [Launcher](https://github.com/docusign/code-examples-python). The Launcher contains a set of 31 common use cases and associated source files. These examples use either DocuSign's [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Tokens (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) flows.
84
-
85
-
## Proof-of-concept applications
65
+
## Code examples
66
+
You can find on our GitHub a self-executing package of code examples for the eSignature C# SDK, called a [Launcher](https://github.com/docusign/code-examples-python/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows.
86
67
87
-
If your goal is to create a proof of concept application, DocuSign provides a set of [Quick Start](https://github.com/docusign/qs-python) examples. The Quick Start examples are meant to be used with DocuSign's [OAuth Token Generator](https://developers.docusign.com/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.
88
-
89
-
## OAuth Implementations
90
-
91
-
For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/esign-rest-api/guides/authentication).
68
+
## OAuth implementations
69
+
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/).
92
70
93
71
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
94
72
95
-
96
73
## Support
97
-
98
74
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
99
75
100
76
## License
77
+
The DocuSign eSignature Python Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-python-client/blob/master/LICENSE).
101
78
102
-
The DocuSign Python Client is licensed under the [MIT License](https://github.com/docusign/docusign-python-client/blob/master/LICENSE).
0 commit comments