Skip to main content

Synchronized alias package for rendo-aclip

Project description

aclip

aclip is the official short-name Python package for ACLIP.

It is published in lockstep with rendo-aclip and installs the same SDK release.

Use aclip if you want the shortest install command. Use rendo-aclip if you want the canonical dependency name in project manifests.

Install

Short-name install:

pip install aclip

Canonical install:

pip install rendo-aclip

Either way, the import path is:

from aclip import AclipApp

What ACLIP gives you

  • natural CLI invocation
  • progressive Markdown help
  • structured result and error envelopes
  • sidecar manifests for distribution metadata
  • packaging helpers for shipping binary CLIs

First Working CLI

from __future__ import annotations

import sys

from aclip import AclipApp


app = AclipApp(
    name="notes",
    version="0.1.1",
    summary="A minimal notes CLI.",
    description="Create and list notes from a small local CLI.",
)

note = app.group(
    "note",
    summary="Manage notes",
    description="Create and inspect notes.",
)


@note.command(
    "create",
    summary="Create a note",
    examples=["notes note create --title hello --body world"],
)
def create(title: str, body: str) -> dict:
    """Create a note.

    Args:
        title: Title for the note.
        body: Body text for the note.
    """
    return {"note": {"title": title, "body": body}}


if __name__ == "__main__":
    raise SystemExit(app.run(sys.argv[1:]))

Typical usage:

notes --help
notes note --help
notes note create --help
notes note create --title hello --body world

Installing aclip installs rendo-aclip==0.1.1.

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-0.1.1.tar.gz (1.9 kB view details)

Uploaded Source

Built Distribution

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

aclip-0.1.1-py3-none-any.whl (1.9 kB view details)

Uploaded Python 3

File details

Details for the file aclip-0.1.1.tar.gz.

File metadata

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

File hashes

Hashes for aclip-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e60d885558c1cf73090f2bf8de64fd4c32a93e6b3c6bf02365e20a03d936ef18
MD5 a637296966a22122eacdf827a78a40b8
BLAKE2b-256 5c883461424f3748d393a4024ce5ab65394afffc18e277484d3694224f8a1dfb

See more details on using hashes here.

File details

Details for the file aclip-0.1.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for aclip-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4d429b476a1832f1eb53244c68d96871e6d7b2bddd73a72b7979202b30a2e93f
MD5 6cde1c89b04c16e22ade29841f9cec1c
BLAKE2b-256 8c8b524d4f6d69a4a415fb07bd975b4634289a10024163e0dc75ccf4088b993f

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