vertodigital
Official Python client for VertoDigital's public agent API. Every endpoint is anonymous, so there's no API key to set up. No runtime dependencies, just the Python standard library.
Install
pip install vertodigital
Usage
from vertodigital import Client
client = Client()
client.health()
# {'status': 'ok', 'service': 'vertodigital-agent-api', ...}
# One page of case studies
page = client.case_studies(limit=10)
for cs in page["items"]:
print(f'{cs["name"]}: {cs["stat"]}')
# Or every case study, paginated for you
urls = [cs["url"] for cs in client.iter_case_studies()]
# Any page on vertodigital.com as markdown
print(client.page("about"))
print(client.llms_txt())
# The OpenAPI 3.1 spec
list(client.openapi()["paths"])
# Submit a contact enquiry on behalf of a user
client.contact(
from_name="Ada Lovelace",
from_email="ada@example.com",
organization="Analytical Engines Ltd",
topic="services", # assessment, services, partnership, press, careers, general
message="We'd like to discuss a marketing analytics engagement.",
)
contact sends an Idempotency-Key automatically. If you retry after a timeout, pass the same idempotency_key= again so the enquiry is only recorded once.
Requests go to the pinned /agent/v1/* paths by default. Pass api_version=None to use the unversioned /agent/* paths.
Errors
vertodigital.APIErrorfor any non-2xx response. It carriesstatusandbody.vertodigital.RateLimitError(a subclass) on 429. It addsretry_afterin seconds.vertodigital.ValidationErrorwhen input fails validation before a request is sent.
All three inherit from vertodigital.VertoDigitalError. Rate limits and the full API reference are at vertodigital.com/developers.
Changelog
- 0.2.0 - Requires Python 3.11 or later (3.8, 3.9 and 3.10 have reached end of life). No API changes.
- 0.1.0 - First release:
health,case_studies/iter_case_studies,contact,openapi,llms_txt,page.
Publishing (maintainers)
From this directory:
python3 -m pip install --upgrade build twine
python3 -m build
python3 -m twine upload dist/*
Bump __version__ in src/vertodigital/_version.py and add a changelog entry on every release. Upload with a PyPI API token (username __token__).
Metadata
Release files for vertodigital 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vertodigital-0.2.0.tar.gz | 6.2 kB | Without provenance | Details for vertodigital-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vertodigital-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for vertodigital-0.2.0-py3-none-any.whl |
Total release size: 13.3 kB
Release files / vertodigital-0.2.0.tar.gz
| Download URL | vertodigital-0.2.0.tar.gz |
|---|---|
| Size | 6.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
46a0c31741b6ffe73f1a54815c0f9781552c58696e82fa87e1d80deaa203b758
|
|
BLAKE2b-256 checksum How to use checksums |
762ee61d424e85f25fb3bf4a7a1a801475d962a2dcf30f8a7c7534bfc4739304
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|
Release files / vertodigital-0.2.0-py3-none-any.whl
| Download URL | vertodigital-0.2.0-py3-none-any.whl |
|---|---|
| Size | 7.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5d7ea10e9b17f99498ed8c284606ce9d519cb952a2c437a37e47b500f7e66ad6
|
|
BLAKE2b-256 checksum How to use checksums |
8fdd164c50d312e21c61b640c04d34727d947ad5bf29eb9db548e42d910b582d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|
Security for vertodigital 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.