Metadata-Version: 2.4
Name: eledoctl
Version: 1.1.1
Summary: Command-line toolkit and async Python API client for Eledo.
Author: Eledo
License: MIT License
        
        Copyright (c) 2026 Eledo
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: api,automation,cli,documents,eledo,pdf,sdk
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Office/Business
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: click>=8.1
Requires-Dist: httpx>=0.27
Requires-Dist: platformdirs>=4.2
Requires-Dist: pyyaml>=6.0
Requires-Dist: types-pyyaml>=6.0
Provides-Extra: repl
Requires-Dist: prompt-toolkit>=3.0; extra == 'repl'
Description-Content-Type: text/markdown

# eledoctl
[![CI](https://github.com/eledo-online/eledoctl/actions/workflows/ci.yml/badge.svg)](https://github.com/eledo-online/eledoctl/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/eledo-online/eledoctl/graph/badge.svg?token=IVVXIPSQHM)](https://codecov.io/gh/eledo-online/eledoctl)
[![Release](https://img.shields.io/github/v/release/eledo-online/eledoctl)](https://github.com/eledo-online/eledoctl/releases)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Eledo](https://img.shields.io/badge/Eledo-green.svg)](https://eledo.online/)
![Eledo PDF automation overview](https://github.com/user-attachments/assets/31ee16e8-7a60-4989-8a73-cf2c3097cfa4)

`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

```text
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.

```python
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

```bash
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

```bash
pip install eledoctl
```

## Development

The project uses modern Python tooling based on `uv`.

### Create or update the development environment

```bash
uv sync --group dev
```

### Run the test suite

```bash
uv run pytest
```

### Run the CLI

```bash
uv run eledoctl --help
```

### Format the code

```bash
uv run ruff format .
```

### Run linting

```bash
uv run ruff check .
```

### Run type checking

```bash
uv run mypy src
```

### Full validation

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