@xc-ventures/xc-platform-documents v1.0.0

Documents

This is a python package to generate Google Docs and Sign Now documents.

Dev

Prerequisites

• Python 3
• Key for the Google Service Account (with access to Google Docs APIs). The json must be in root folder, named key.json
• A Sign Now Sandbox account with an API key. .env file must be setup using .env.template
• We recommend to use a virtual environment for python. There are many different tools to do that, but here, we will demonstrate with VirtualEnv

How to get started

1. Let's start by creating a new virtual environment in the root of this repo. You shouldn't have to execute that again, unless you reset it.

python -m venv venv

2. To start the virtual env (macOS):

source venv/bin/activate

3. Now it's time to install all the dependencies to run this project. You won't need to execute that again, unless you reset your virtual env or the requirements changed.

pip install -r requirements.txt

4. To run the project

python start.py

Tests

To run the unit tests, run this command line in your virtual env.

python -m pytest

Tips

Inside the virtual env, if you want to quit it:

$ deactivate

Installation

Using pip, it is possible to install the tools in this repo as a package so you can import them in other projects.

Prerequisites

• Same prerequisites as mentionned above
• Active SSH key pointing to repo with read access

How to install

pip install git+ssh://git@bitbucket.org/decksign/documents.git

You can specify a version using git tags. E.g.:

pip install git+ssh://git@bitbucket.org/decksig/documents.git@0.1.0

Templating Guidelines

The Google Doc templates we use with this repo must respect a certain nomenclature in order to work properly.

Variables

Variables must be defined with doubled curly brackets, like so:

Hello World, my name is {{first_name}}!

Here, first_name would be the var name.

Signature

Signature tags are for Google Docs that will be uploaded to Sign Now. They represent a full signature. They must be defined with doubled brackets and a role, like so:

Signature:

[[signature:ceo]]
CEO

Here, the role would be ceo.

Initials

Initials tags are for Google Docs that will be uploaded to Sign Now. They represent an initials. They must be defined with doubled brackets and a role, like so:

Initials:

[[initials:ceo]]
CEO

Here, the role would be ceo.

Note about Signature and Initials

In the process to uploading it to Sign Now, this package will update the Google Doc to replace the tags with a line of the same size of the tag itself. It is possible to make the line bigger by adding "_" chars following by a ":" in the first part of the tag, like so:

[[_______:signature:ceo]]

[[________:initials:ceo]]

Documentation

Class Document

This class provides a few tools allowing you to manipulate Google Docs templates (enter data), copy, share it. You can also use this class to upload PDF version of that Google Doc to Sign Now and invite people to sign it.

from documents import Document

Constructor args

Properties

methods

Class SignNowInvite

This class represents an invitation for a Sign Now document.

from documents.services.signnow.document import SignNowInvite

Constructor args

Properties

Class GoogleDoc

This class represents a Google Doc file.

from documents.services.google.doc import GoogleDoc

Constructor args

Properties

Methods

Module documents.services.signnow.auth

Function verify_access_token

Verifies that the given access token is valid for your account. This is useful for webhooks, to verify that the request is legitimate (webhook callbacks contain an access_token).

args

Module documents.services.signnow.webhook

Function create_doc_completion_webhook

Creates an event subcription for a document completion (when all parties completed their signature). The webhook will call the URL given in the SIGNNOW_API_DOC_COMPLETION_CALLBACK_URL env var when the event is triggered.

args

Function create_doc_opening_webhook

Creates an event subcription for a document being opened. The webhook will call the URL given in the SIGNNOW_API_DOC_OPEN_CALLBACK_URL env var when the event is triggered.

args

Function create_doc_update_webhook

Creates an event subcription for a document being updated (including an user signing the doc). The webhook will call the URL given in the SIGNNOW_API_DOC_UPDATE_CALLBACK_URL env var when the event is triggered.

args

Function delete_webhook

Removes a webhook from your Sign Now account. This can be useful when the event subscription is no longer needed or is no longer possible.

args

Function list_webhooks

Lists all the webhooks of your Sign Now account.

Module documents.services.google.drive

Function copy_file

Duplicate the specified file. The copy will be in the same folder as the original.

args

Function lock_file

Updates the specified file to be read-only.

args

Function unlock_file

Updates the specified file to disable the Read-Only mode.

args

Function delete_file

Deletes the specified file.

args

Function move_file

Moves the specified file into the specified folder.

args

Function create_folder

Creates a new folder inside the given folder.

args

Function share_file

Gives the specified role to the specified users.

args

Function upload_pdf

Upload a PDF file with the given name to the specified folder.

args

Function download_pdf

Downloads the specified file in PDF format. Returns the bytes.

args