Skip to main content

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.

Metadata

Release files for signhost-api-python-client 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for signhost-api-python-client 0.3.0
File Size Uploaded
signhost_api_python_client-0.3.0.tar.gz 13.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for signhost-api-python-client 0.3.0
File Interpreter ABI Platform
signhost_api_python_client-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 31.8 kB

Release files / signhost_api_python_client-0.3.0.tar.gz

Download URL signhost_api_python_client-0.3.0.tar.gz
Size 13.9 kB
Tags Source
SHA-256 checksum
How to use checksums
820311284e1f4cb2717b2de6895dfee8f260f6c37b05337781bb9a27c42fad00
BLAKE2b-256 checksum
How to use checksums
32f0323adef02c96684d1f798d714f4eba1da3341f2ab264261f568f059ef318
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.4

Release files / signhost_api_python_client-0.3.0-py3-none-any.whl

Download URL signhost_api_python_client-0.3.0-py3-none-any.whl
Size 17.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e8e0c3a5810dcc1c360aba508d23078dde703a377410f7a872e555be8b34fbe7
BLAKE2b-256 checksum
How to use checksums
d4c6bf04c20d70b2a48973c94ae1a246239fff8324dcb50804aa3b92a4e246d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.4

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.0

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page