Skip to main content

Signhost Api Python Client

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

signhost_api_python_client-0.3.0.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

signhost_api_python_client-0.3.0-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file signhost_api_python_client-0.3.0.tar.gz.

File metadata

File hashes

Hashes for signhost_api_python_client-0.3.0.tar.gz
Algorithm Hash digest
SHA256 820311284e1f4cb2717b2de6895dfee8f260f6c37b05337781bb9a27c42fad00
MD5 6eb3b3445765004f9615b9733efdb84c
BLAKE2b-256 32f0323adef02c96684d1f798d714f4eba1da3341f2ab264261f568f059ef318

See more details on using hashes here.

File details

Details for the file signhost_api_python_client-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for signhost_api_python_client-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e8e0c3a5810dcc1c360aba508d23078dde703a377410f7a872e555be8b34fbe7
MD5 68a0677f4e118a42be708856b40a679c
BLAKE2b-256 d4c6bf04c20d70b2a48973c94ae1a246239fff8324dcb50804aa3b92a4e246d0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page