Signhost Api Python Client#

PyPI Status Python Version License

Read the documentation at https://signhost-api-python-client.readthedocs.io/ Tests Codecov

pre-commit Black

Features#

  • 100% test coverage

Requirements#

  • httpx

  • pydantic

  • attrs

  • click

Installation#

You can install Signhost Api Python Client via pip from PyPI:

$ pip install signhost-api-python-client

Usage#

import io
from signhost import models
from signhost.client import DefaultClient

signhost = DefaultClient(api_key="str", app_key="str")
transaction = models.Transaction(signers=[models.Signer(email="str")])

transaction = signhost.transaction_init(transaction=transaction)
signhost.transaction_file_put(
    transaction.Id,
    "file.pdf",
    io.BytesIO(b"test"),
)
transaction = signhost.transaction_start(transaction.Id)

print("Sign the contract over here", transaction.Signers[0].SignUrl)

signhost.transaction_get(transaction.Id)
signhost.transaction_file_get(transaction.Id, "file.pdf")
signhost.receipt_get(transaction.Id)

Async support#

from signhost.client import AsyncClient

async with AsyncClient(api_key="str", app_key="str") as signhost:
    signhost.transaction_get("xyz")

Please see the Command-line Reference for details.

Contributing#

Contributions are very welcome. To learn more, see the Contributor Guide.

License#

Distributed under the terms of the MIT license, Signhost Api Python Client is free and open source software.

Issues#

If you encounter any problems, please file an issue along with a detailed description.

Credits#

This project was initiated by dok.legal and was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.