Skip to main content

Python reference SDK for the Agent Command Line Interface Protocol

Project description

aclip-sdk

aclip-sdk 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 aclip-sdk

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

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

aclip_sdk-0.1.0.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

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

aclip_sdk-0.1.0-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aclip_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e9f3b9c75f4c78bf277dfb325350af673ac3b10e99fdf410c538c405f2f6f114
MD5 81c76675b7cc0939f84e9e741108652d
BLAKE2b-256 f5055ba4f7f6108ab60369bd678af14ad3b906ccbb5c3dc8ed2d5d01c860008f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for aclip_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e847406fc1ff5c5bd806db3e4707b1a3ea1ea6b0119f6d91dc97bb728e901df2
MD5 494a5c7d6a4c7882ef926d37a697700f
BLAKE2b-256 91d7bf08b6b407729f39dc2400b878353bcab27565c0d909d471462959b1261c

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