asyoulikeit 0.2.1

Configurable CLI report asyoulikeit for Python projects.

asyoulikeit

--as tsv | json | display → as you like it

Multi-format report output for Python CLIs — JSON for machines, TSV for pipes, display for humans.

Quickstart

Write a handler that returns a Reports object and decorate it with @tabulated_output:

"""Quickstart example: list a handful of programming languages as a Report.

Run this file directly to see the default display format:

    python scripts/examples/quickstart.py

Or force a specific format:

    python scripts/examples/quickstart.py --as tsv
    python scripts/examples/quickstart.py --as json

The ``scripts/generate_readme.py`` generator imports this file, invokes the
command with each built-in format, and injects the source + captured outputs
into the README.
"""

import click

from asyoulikeit import (
    Importance,
    Report,
    Reports,
    TabularData,
    tabulated_output,
)


@click.command()
@tabulated_output
def list_languages():
    """List some well-known programming languages."""
    data = (
        TabularData(
            title="Programming languages",
            description="A small sample of notable programming languages.",
        )
        .add_column("name", "Name")
        .add_column("year", "Year")
        .add_column("paradigm", "Paradigm")
        .add_column("typing", "Typing", importance=Importance.DETAIL)
        .add_row(name="Python", year=1991, paradigm="Multi-paradigm", typing="Dynamic, duck")
        .add_row(name="Haskell", year=1990, paradigm="Functional", typing="Static, inferred")
        .add_row(name="Go", year=2009, paradigm="Imperative", typing="Static, structural")
    )
    return Reports(languages=Report(data=data))


if __name__ == "__main__":
    list_languages()

The decorator injects --as, --report, --header/--no-header, and --detailed/--essential options into the command. --as defaults to display when stdout is a terminal, tsv when piped.

--as tsv

# Name	Year	Paradigm
Python	1991	Multi-paradigm
Haskell	1990	Functional
Go	2009	Imperative

--as json

{
  "tables": {
    "languages": {
      "metadata": {
        "title": "Programming languages",
        "description": "A small sample of notable programming languages.",
        "present_transposed": false
      },
      "columns": [
        {
          "key": "name",
          "label": "Name",
          "header": false
        },
        {
          "key": "year",
          "label": "Year",
          "header": false
        },
        {
          "key": "paradigm",
          "label": "Paradigm",
          "header": false
        },
        {
          "key": "typing",
          "label": "Typing",
          "header": false
        }
      ],
      "rows": [
        {
          "name": "Python",
          "year": 1991,
          "paradigm": "Multi-paradigm",
          "typing": "Dynamic, duck"
        },
        {
          "name": "Haskell",
          "year": 1990,
          "paradigm": "Functional",
          "typing": "Static, inferred"
        },
        {
          "name": "Go",
          "year": 2009,
          "paradigm": "Imperative",
          "typing": "Static, structural"
        }
      ]
    }
  }
}

--as display

                 Programming languages                  
┏━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓
┃ Name    ┃ Year ┃ Paradigm       ┃ Typing             ┃
┡━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩
│ Python  │ 1991 │ Multi-paradigm │ Dynamic, duck      │
│ Haskell │ 1990 │ Functional     │ Static, inferred   │
│ Go      │ 2009 │ Imperative     │ Static, structural │
└─────────┴──────┴────────────────┴────────────────────┘
    A small sample of notable programming languages.

License

MIT — see LICENSE.

---

This README is generated by scripts/generate_readme.py from scripts/readme_template.md.j2 and scripts/examples/. Do not edit directly; re-run the generator after any change.