Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Generate command-line interfaces (CLI) by introspecting callables

Project Description

Xacto

CLI Analyzer/Generator

Introspect, compose, marshal and export arbitrary callables into a unified, hierarchical, command-line interface (CLI)

Features

auto-find tools scan signatures and export as CLI node

Why

FAST! EASY! natural import usage! --help is decent!

Quickstart

  1. Install:

    # pip install xacto
    
  2. Prepare:

    # ln -s $(which xacto) do
    
  3. Create python file at tools/work.py:

from pprint import pprint


__all__ = ["easy", "hard", "manual"]


def easy(method, speed=16, *tasks):
    """The simple version"""
    pprint(locals())


def hard(method, speed=32, *tasks, **params):
    """The difficult version"""
    pprint(locals())


class manual(object):
    """The laborious version"""

    def __call__(self, method, speed, *tasks):
        pprint(locals())

    def method(self, process):
        """Howto perform operation"""

    def speed(self, ops=64):
        """Operations per second"""

    def tasks(self, pri, sec, ter):
        """Various tasks"""
  1. View --help:

    # ./do work --help
    usage: do work OBJECT ...
    
    additional modules:
      OBJECT  := { .do.work }
        easy  The simple version
        hard  The difficult version
        manual
              The laborious version
    
  2. View object-level --help:

    # ./do work manual --help
    usage: do work manual --method PROCESS --speed [OPS] [tasks [tasks ...]]
    
    The laborious version
    
    positional arguments:
      tasks             Various tasks
    
    optional arguments:
      --method PROCESS  Howto perform operation
      --speed [OPS]     Operations per second
    
    The laborious version
    
  3. Run tool (function):

    # ./do work hard --method=cheat --code=iddqd taskN
    {'method': 'cheat',
     'params': {'code': 'iddqd'},
     'speed': 32,
     'tasks': ('taskN',)}
    
  4. Run tool (class):

    # ./do work manual --method=cheap --speed=256 taskN
    {'method': 'cheap',
     'self': <do.work.manual object at ...>,
     'speed': '256',
     'tasks': ('taskN',)}
    

Limitations

  • true/false quirkyness (default=True means –default flips to False)

TODO

  • RELEASE!
  • testing: set-like functions, import semantics.. everything
  • handle bools better
  • detect output
  • standard output structure
  • prettify to tty
  • lazy load tools
  • lazy import globals (cpython)
  • bytecode cache
  • argument forwarding/chaining
  • integrate with zippy.shell
  • tab-completion
  • auto-reduce common components for aliases
  • make xacto object accessible to tools
Release History

Release History

This version
History Node

0.8.7

History Node

0.8.6

History Node

0.8.5

History Node

0.8.4

History Node

0.8.3

History Node

0.8.2

History Node

0.6.3

History Node

0.6.2

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
xacto-0.8.7-py2-none-any.whl (15.2 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Dec 9, 2015
xacto-0.8.7-py3-none-any.whl (15.2 kB) Copy SHA256 Checksum SHA256 3.5 Wheel Dec 9, 2015
xacto-0.8.7.tar.gz (15.3 kB) Copy SHA256 Checksum SHA256 Source Dec 9, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting