Package: hellosign-python-sdk-custom
Hellosign Python SDK-------------------A Python wrapper with some custom requirements (that have been ignore in main repo) for the [HelloSign API](http://www.hellosign.com/api)## InstallationInstall using `easy_install`:````sheasy_install hellosign-python-sdk-custom````Install using `pip`:````shpip install hellosign-python-sdk-custom````Install from code:````shgit clone https://github.com/customtech/hellosign-python-sdk.gitcd hellosign-python-sdkpython setup.py install````## ConfigurationIn your application, import `HSClient`:````pythonfrom hellosign_sdk import HSClient````Then create a HSClient object and pass authentication information to initialize it:````python# Initialize HSClient using email and passwordclient = HSClient(email_address="api_user@example.com", password="your_password")# Initialize HSClient using api keyclient = HSClient(api_key="your_api_key")# Initialize HSClient using api tokenclient = HSClient(access_token="your_api_access_token")````Note: In case you initialize the HSClient with all the above credentials, the priority order is as follow: access_token, api_key, then email and password.## UsageFor more information about the wrapper, its methods and parameters visit our detailed API documentation on  [readthedocs](http://hellosign-python-sdk.readthedocs.org/en/v3/py-modindex.html).### Account#### Get current account information````pythonaccount = client.get_account_info()````The account information is also stored in `client.account`. For example, to print the `email_address` of your account:````pythonprint client.account.email_address````#### Update your account information````pythonclient.account.callback_url = "https://www.example.com/callback"client.update_account_info()````#### Create a new HelloSign account````pythonnew_account = client.create_account("new_user@example.com")````### Signature Request#### Get a Signature Request````pythonsignature_request = client.get_signature_request("fa5c8a0b0f492d768749333ad6fcc214c111e967")print signature_request.requester_email_addressprint signature_request.signature_request_id````#### Get a list of your Signature Requests````pythonsignature_request_list = client.get_signature_request_list(page=1)# Print out the name of the signers in every signature requestfor signature_request in signature_request_list:print signature_request.signatures[0].signer_name````#### Send a Signature Request````pythonfiles = ["NDA.pdf", "AppendixA.pdf"]signers = [{"name": "Jack", "email_address": "jack@example.com"},{"name": "Jill", "email_address": "jill@example.com"}]cc_email_addresses = ["lawyer@hellosign.com", "lawyer@example.com"]# Send a signature request with remote filessignature_request = client.send_signature_request(test_mode=True,files=None,file_urls=["http://www.example.com/download/sample.pdf"],title="NDA with Acme Co.",subject="The NDA we talked about",message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",signing_redirect_url=None,signers=signers,cc_email_addresses=cc_email_addresses)# Send a signature request with uploaded filessignature_request = client.send_signature_request(test_mode=True,files=files,file_urls=None,title="NDA with Acme Co.",subject="The NDA we talked about",message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",signing_redirect_url=None,signers=signers,cc_email_addresses=cc_email_addresses)````#### Send a Signature Request with Template````pythonsigners = [{"name": "Jack", "email_address": "jack@example.com"},{"name": "Jill", "email_address": "jill@example.com"}]cc_email_addresses = ["lawyer@hellosign.com", "lawyer@example.com"]ccs = [{ "email_address": "lawyer@hellosign.com", "role_name": "Lawyer 1" },{ "email_address": "lawyer@example.com", "role_name": "Lawyer 2" }]custom_fields = [{ "Field 1": "Value 1" },{ "Field 2": "Value 2" }]# Send a signature request with uploaded filessignature_request = client.send_signature_request_with_template(test_mode=True,template_id="fa5c8a0b0f492d768749333ad6fcc214c111e967",title="NDA with Acme Co.",subject="The NDA we talked about",message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",signing_redirect_url=None,signers=signers,ccs=ccs,custom_fields=custom_fields)````### Embedded#### Embedded signing````pythonsigners = [{"name": "Jack", "email_address": "jack@example.com"},{"name": "Jill", "email_address": "jill@example.com"}]signature_request = client.send_signature_request_embedded(test_mode=True,client_id="YOUR CLIENT ID",files=["path/to/NDA.pdf"],title="NDA with Acme Co.",subject="The NDA we talked about",message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",signing_redirect_url=Nonesigners=signers,cc_email_addresses=None,form_fields_per_document=None)# Retrieve the signature url to pass to the embedded iFramefor signature in signature_request.signatures:embedded_obj = client.get_embedded_object(signature.signature_id)sign_url = embedded_obj.sign_url````More information about the asscociated front-end code can be found [here](https://www.hellosign.com/api/embeddedSigningWalkthrough#ClientSide)#### Embedded requesting````python# Create a draft and retrieve the claim urldraft = client.create_embedded_unclaimed_draft(test_mode=True,client_id="YOUR CLIENT ID",requester_email_address="requester@example.com",files=["path/to/NDA.pdf"],draft_type="signature_request",subject="The NDA we talked about",message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",is_for_embedded_signing=False)claim_url = draft.claim_url````More information about the asscociated front-end code can be found [here](https://www.hellosign.com/api/embeddedRequestingWalkthrough#ClientSideRequesting)Once the user edits the draft in the embedded iFrame and sends the signature request your app callback will receive a `signature_request_sent` event containing a `SignatureRequest` object. If we had used `is_for_embedded_signing=True`, we would want to get the signature ids out of the `SignatureRequest` from that event and fetch the signature urls at this point. In your event callback handler, you will need to do something like this:````pythonclient = HSClient(api_key='your_api_key')event_data = json.loads(request.POST.get('json'))if event_data['event']['event_type'] == 'signature_request_sent':sig_req = event_data['signature_request']for sig in sig_req['signature_request']['signatures']:embedded_obj = client.get_embedded_object(sig['signature_id'])sign_url = embedded_obj.sign_url# Save sign_url somewhere````## TestsYou can run the test suite by executing the following commands after you cloned the repo:Note that it requires to have a HelloSign account, with at least one template and one api app.**WARNING:** We advise against running the tests against your personal account as they perform destructive actions.```cd hellosign_sdkcp tests/test_helper.sample.py tests/test_helper.pyHELLOSIGN_API_KEY='YOUR API KEY'HELLOSIGN_API_CLIENT_ID='YOUR APP CLIENT ID'HELLOSIGN_API_CLIENT_SECRET='YOUR APP CLIENT SECRET'nosetests --with-coverage --cover-package=hellosign_sdk --include=hellosign_sdk/tests/unit_tests/* --include=hellosign_sdk/tests/functional_tests/*```## Additional notes### Local callbacksWe do not allow app callbacks (event or OAuth) to be set to localhost. However it is still possible to test callbacks against a local server. Tunneling services such as [ngrok](http://ngrok.com) can help you set this up.## License```The MIT License (MIT)Copyright (C) 2015 hellosign.comPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.```