Skip to content

create repo structure #1

@drernie

Description

@drernie

Create quiltx Repo Structure (Library + Tools)

1. Goal

Create a single GitHub repo named quiltx that contains:

  • a small, public Python library (quiltx)
  • a set of single-purpose CLIs (“quiltx tools”) that depend on that library

Optimize for:

  • simplicity
  • low ceremony
  • uv / uvx compatibility
  • independent evolution of tools

2. Naming Conventions

  • Library (PyPI + import):
    • distribution: quiltx
    • import: import quiltx
  • Tools:
    • distribution / CLI: quiltx-<tool>
    • examples: quiltx-log, quiltx-stack
  • Vocabulary:
    • call them “quiltx tools”
    • do not use “extensions”, “plugins”, etc.

3. Repo Layout (Required)

./
├─ quiltx/                 # the shared library
│  ├─ pyproject.toml
│  └─ quiltx/
│     ├─ __init__.py
│     └─ …
│
├─ tools/                  # quiltx tools (each is a package)
│  ├─ quiltx-log/
│  │  ├─ pyproject.toml
│  │  └─ quiltx_log/
│  │     └─ cli.py
│  │
│  ├─ quiltx-stack/
│  │  ├─ pyproject.toml
│  │  └─ quiltx_stack/
│  │     └─ cli.py
│
├─ pyproject.toml          # workspace root
├─ uv.lock
└─ README.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions