Skip to main content

eledoctl

CI codecov Release License: MIT Eledo Eledo PDF automation overview

eledoctl is an open-source command-line toolkit for Eledo.

It contains two Python modules:

  • pyeledo — async-native Python API client for Eledo REST APIs
  • eledoctl — CLI, REPL, and automation layer built on top of pyeledo

The project is MIT licensed. Public functionality is exposed through pyeledo and eledoctl, while internal Eledo tooling is implemented as optional extensions.

Architecture

repo/
├── src/
│   ├── pyeledo/       # Async SDK / REST client
│   └── eledoctl/      # CLI / REPL / orchestration
└── tests/
    ├── pyeledo/
    └── eledoctl/

pyeledo is async-first and async-only. It never stores credentials. Tokens are passed to the client by the caller.

from pyeledo import EledoClient, TemplateScope

async with EledoClient(token="...") as client:
    profile = await client.get_profile()
    templates = await client.get_templates(scope=TemplateScope.PRIVATE)

Initial CLI Tree

eledoctl login
eledoctl profile
eledoctl templates
eledoctl documents generate TEMPLATE_ID --payload payload.json --output output.pdf
eledoctl internal

For now the CLI passes an empty token unless --token is provided. Persistent token storage will be added later in eledoctl, not in pyeledo.

Installation

pip install eledoctl

Development

The project uses modern Python tooling based on uv.

Create or update the development environment

uv sync --group dev

Run the test suite

uv run pytest

Run the CLI

uv run eledoctl --help

Format the code

uv run ruff format .

Run linting

uv run ruff check .

Run type checking

uv run mypy src

Full validation

uv run ruff format .
uv run ruff check .
uv run mypy src
uv run pytest

Download files

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

Source Distribution

eledoctl-1.3.0.tar.gz (27.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eledoctl-1.3.0-py3-none-any.whl (39.4 kB view details)

Uploaded Python 3

File details

Details for the file eledoctl-1.3.0.tar.gz.

File metadata

  • Download URL: eledoctl-1.3.0.tar.gz
  • Upload date:
  • Size: 27.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for eledoctl-1.3.0.tar.gz
Algorithm Hash digest
SHA256 fdc2b83deb263d776f452fc0cf435258b547cda334fe83f6c345eb64dd99e66e
MD5 677de8e118da36546124f8f04f47839f
BLAKE2b-256 5829e9144a3b00dca4f84518cac31aa860a78b2397539339f47dd6fa701215a5

See more details on using hashes here.

Provenance

The following attestation bundles were made for eledoctl-1.3.0.tar.gz:

Publisher: publish.yml on eledo-online/eledoctl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file eledoctl-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: eledoctl-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 39.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for eledoctl-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8995d9adffa5a5f8f84f2d8aa691d43a7d6514ef360a5286af456a8774730326
MD5 38e8c2d32f99077472ada21722a92182
BLAKE2b-256 787d91ad881e7df4e60183b07fa7988a037a38b93a076df75b89c4fe50be70a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for eledoctl-1.3.0-py3-none-any.whl:

Publisher: publish.yml on eledo-online/eledoctl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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