Skip to content

Commit a98f136

Browse files
committed
docs(readme): add badges, family table, credits
1 parent c97d817 commit a98f136

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
└──────────────────────────────────────────────────┘
77
```
88

9+
[![PyPI](https://img.shields.io/pypi/v/codechu-cli.svg)](https://pypi.org/project/codechu-cli/)
10+
[![Python](https://img.shields.io/pypi/pyversions/codechu-cli.svg)](https://pypi.org/project/codechu-cli/)
11+
[![CI](https://github.com/codechu/cli-py/actions/workflows/ci.yml/badge.svg)](https://github.com/codechu/cli-py/actions/workflows/ci.yml)
12+
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
13+
914
> *Colors, progress bars, spinners, prompts — terminal UX in one import.*
1015
1116
# codechu-cli
@@ -440,6 +445,33 @@ Style names (the keys in `SPINNER_STYLES`, `BAR_STYLES`) are part of the
440445
requires a deprecation cycle (warn for one minor version, then remove
441446
on the next). Family names and tag names follow the same rule.
442447

448+
## Codechu family
449+
450+
Companion libraries from the Codechu Python ecosystem:
451+
452+
| Library | Purpose |
453+
|---------|---------|
454+
| [codechu-fmt](https://pypi.org/project/codechu-fmt/) | Human-readable formatting — sizes, durations, rates, percent |
455+
| [codechu-meter](https://pypi.org/project/codechu-meter/) | Timing primitives — Stopwatch, ETA, percentile, histogram |
456+
| [codechu-spark](https://pypi.org/project/codechu-spark/) | Unicode sparklines, mini bar charts, heatmaps |
457+
| [codechu-events](https://pypi.org/project/codechu-events/) | Thread-safe multi-channel pub/sub bus with replay |
458+
| [codechu-xdg](https://pypi.org/project/codechu-xdg/) | XDG Base Directory helpers, vendor-namespaced |
459+
| [codechu-treeviz](https://pypi.org/project/codechu-treeviz/) | Tree visualization — treemap, sunburst, icicle, flame |
460+
| [codechu-fs](https://pypi.org/project/codechu-fs/) | Filesystem primitives — atomic write, XDG trash, safe walk |
461+
| [codechu-term](https://pypi.org/project/codechu-term/) | Terminal capability detection, alt buffer, raw mode |
462+
| [codechu-color](https://pypi.org/project/codechu-color/) | Color palettes, WCAG contrast, color-blind variants |
463+
| [codechu-treedata](https://pypi.org/project/codechu-treedata/) | N-ary tree data structures and algorithms |
464+
| [codechu-log](https://pypi.org/project/codechu-log/) | Structured logging — context, JSON, rotation, redaction |
465+
| [codechu-i18n](https://pypi.org/project/codechu-i18n/) | Internationalization — locale, plural rules, RTL |
466+
| [codechu-ipc](https://pypi.org/project/codechu-ipc/) | Local IPC — Unix socket, FIFO, JSON-line protocol |
467+
| [codechu-config](https://pypi.org/project/codechu-config/) | Schema-driven config — atomic save, migrations |
468+
469+
## Credits
470+
471+
- Spinner glyph styles adapted from [cli-spinners](https://github.com/sindresorhus/cli-spinners)
472+
- ANSI escape conventions per ECMA-48
473+
- Inspiration from [rich](https://github.com/Textualize/rich) and [questionary](https://github.com/tmbo/questionary); codechu-cli stays stdlib-only with line-oriented output
474+
443475
## License
444476

445477
MIT — see [LICENSE](LICENSE).

0 commit comments

Comments
 (0)