From cabf753326655918211c0008ad4381b10b773b4e Mon Sep 17 00:00:00 2001 From: Paul Huliganga Date: Thu, 16 Apr 2026 12:35:13 -0400 Subject: [PATCH] =?UTF-8?q?docs:=20update=20README=20=E2=80=94=20reference?= =?UTF-8?q?=20.env-sample=20and=20mention=20conditional=20logic?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Setup step 2 now directs users to copy .env-sample instead of repeating all variables inline - "What it does" step 3 mentions conditional field logic - Field type mapping section updated to mention conditional logic Co-Authored-By: Claude Sonnet 4.6 --- README.md | 27 ++++++++------------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index c997d42..eaf8477 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ It downloads templates via the Adobe Sign API, converts them to DocuSign format, 1. **Authenticates** with Adobe Sign via OAuth (one-time browser flow, tokens saved to `.env`) 2. **Downloads** templates — PDF, metadata, and form field definitions -3. **Converts** each template to a DocuSign `envelopeTemplate` JSON, mapping all field types, coordinates, and recipient roles +3. **Converts** each template to a DocuSign `envelopeTemplate` JSON, mapping all field types, coordinates, recipient roles, and conditional field logic 4. **Authenticates** with DocuSign via JWT grant (one-time browser consent, then fully automated) 5. **Uploads** the converted template to DocuSign via the REST API @@ -31,24 +31,13 @@ pip install -r requirements.txt ``` **2. Create a `.env` file** in the project root (never commit this): +```bash +cp .env-sample .env ``` -# Adobe Sign -ADOBE_CLIENT_ID=your-adobe-client-id -ADOBE_CLIENT_SECRET=your-adobe-client-secret - -# DocuSign -DOCUSIGN_CLIENT_ID=your-integration-key -DOCUSIGN_CLIENT_SECRET=your-client-secret -DOCUSIGN_USER_ID=your-docusign-user-guid -DOCUSIGN_ACCOUNT_ID=your-docusign-account-id -DOCUSIGN_PRIVATE_KEY_PATH=/path/to/private.key -DOCUSIGN_AUTH_SERVER=account-d.docusign.com -DOCUSIGN_BASE_URL=https://demo.docusign.net/restapi -DOCUSIGN_REDIRECT_URI=http://localhost:8080/callback -``` - -Use `account-d.docusign.com` and `https://demo.docusign.net/restapi` for sandbox. -For production replace with `account.docusign.com` and your account's base URL (e.g. `https://na3.docusign.net/restapi`). +Then fill in your credentials. See [.env-sample](.env-sample) for the full list of +variables with descriptions. Use `account-d.docusign.com` and +`https://demo.docusign.net/restapi` for sandbox; for production replace with +`account.docusign.com` and your account's base URL (e.g. `https://na3.docusign.net/restapi`). **3. Authenticate with Adobe Sign** (one-time): ```bash @@ -107,7 +96,7 @@ If multiple templates share the same name, the most recently modified one is use ## Field type mapping See [field-mapping.md](field-mapping.md) for the full Adobe Sign → DocuSign tab type table, -including edge cases and known gaps. +conditional logic mapping, and known gaps. ## Known API quirks and bugs