Skip to main content

Python reference SDK for the Agent Command Line Interface Protocol

Project description

rendo-aclip

rendo-aclip is the Python reference adapter for ACLIP.

It does not define the ACLIP protocol.

It implements the shared protocol contracts maintained at the repository root and provides Python authoring, runtime, and packaging helpers for ACLIP-compatible CLIs.

What it provides

  • AclipApp tree-shaped authoring
  • CommandSpec, CommandGroupSpec, and ArgumentSpec
  • canonical ACLIP Markdown help rendering
  • structured result and error envelopes
  • binary packaging through package_binary()
  • packaging CLI through aclip-package

Install

pip install rendo-aclip

Short-name compatibility alias:

pip install aclip

aclip is published as a synchronized alias package and should always resolve to the same SDK release as rendo-aclip.

Quick Start

from aclip import AclipApp, ArgumentSpec

app = AclipApp(
    name="demo",
    version="0.1.0",
    summary="Demo CLI",
    description="Demo CLI.",
)

app.command_groups.append(...)

The recommended higher-level authoring path is to use AclipApp.group() and @group.command() from your own module entrypoint.

Packaging

from pathlib import Path

from aclip import package_binary

artifact = package_binary(
    app=app,
    binary_name="demo",
    entry_script=Path("src/demo_cli/__main__.py"),
    project_root=Path(".").resolve(),
    source_root=Path("src").resolve(),
)

Local Development

python -m venv .venv
.\.venv\Scripts\python -m pip install -e .[dev]
.\.venv\Scripts\python -m pytest tests -q

Release

..\..\..\.venv\Scripts\python.exe .\scripts\publish.py check
..\..\..\.venv\Scripts\python.exe .\scripts\publish.py publish

Required environment:

  • PYPI_TOKEN

Project details


Download files

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

Source Distribution

rendo_aclip-0.1.0.tar.gz (20.7 kB view details)

Uploaded Source

Built Distribution

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

rendo_aclip-0.1.0-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file rendo_aclip-0.1.0.tar.gz.

File metadata

  • Download URL: rendo_aclip-0.1.0.tar.gz
  • Upload date:
  • Size: 20.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for rendo_aclip-0.1.0.tar.gz
Algorithm Hash digest
SHA256 14cacdaf99ec7483b233634a9daf77325231bed34383d1905f8e2a763afd113f
MD5 86ea552cfc338a898cdfda08d5e5027a
BLAKE2b-256 a33467e93d2910a47d77346cc06e723dbe95a442f5496c0b90c800cbfa6a128f

See more details on using hashes here.

File details

Details for the file rendo_aclip-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: rendo_aclip-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for rendo_aclip-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b963308829c8ba388c5b03ae0fc7692cdd8d42a9dc920007dbe548ae97ebff6
MD5 2571aac2731085874906eb857bc46940
BLAKE2b-256 9d7a8dae7576fc0aa4f93815c800843a12f8579f3aab2fa3090984214759b20d

See more details on using hashes here.

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