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.2.1.tar.gz (25.9 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.2.1-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for eledoctl-1.2.1.tar.gz
Algorithm Hash digest
SHA256 3b3defa9e4db6b3b55608f2ae62e260dd8cb65506d1f6798f2bcb55f2780ec65
MD5 1586464ee59e61f2ff63483afb147f96
BLAKE2b-256 73a8c27ba27a2e60302ca341e34babb15f2a9be17ba305957181ab07ffca8e16

See more details on using hashes here.

Provenance

The following attestation bundles were made for eledoctl-1.2.1.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.2.1-py3-none-any.whl.

File metadata

  • Download URL: eledoctl-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 35.9 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 31a3a532a849830df4bf41fd0a7f97613854ea43b501f3a346d3c346bcbc6c79
MD5 2d424aa82a3e9a2e39a70f32a15d2352
BLAKE2b-256 6fab8f285037d01adac32b9977d83b32fbee65b778ae4ed34d8e37f93a7b1b8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for eledoctl-1.2.1-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