Skip to main content

CLI utilities for packaging and installing Vale styles

Project description

Stilyagi

Stilyagi is a Cyclopts-based command line tool for packaging Vale styles and dropping them into writing projects. It no longer ships the Concordat style ruleset itself; that style now lives in a dedicated repository.

What it does

  • Build reproducible ZIP archives from a Vale style checkout, ready to attach to a release.
  • Update a consumer repository so Vale downloads and applies a packaged style, including optional post-sync steps defined in a manifest.
  • Merge curated word lists into Tengo maps that Vale can read.

The end-to-end workflows, command options, and troubleshooting notes live in docs/users-guide.md.

Quick start

uv sync --group dev
  • Package a style from its checkout:

    uv run stilyagi zip --project-root /path/to/style --archive-version 1.2.3
    
  • Point a consumer repository at a released archive:

    uv run stilyagi install owner/repo \
      --project-root /path/to/consumer \
      --release-version 1.2.3
    
  • Merge entries into a Tengo map that Vale uses:

    uv run stilyagi update-tengo-map \
      --source .config/common-acronyms \
      --dest .vale/styles/config/scripts/AcronymsFirstUse.tengo
    

See docs/users-guide.md for fuller examples, defaults, and caveats.

Repository layout

  • stilyagi/ – CLI entry points and helpers for packaging, installation, and Tengo map updates.
  • docs/ – User and design documentation. Start with docs/users-guide.md for everyday usage.
  • features/ – Behaviour-driven feature files that exercise the CLI end to end.
  • tests/ and test_helpers/ – Unit and integration coverage.
  • scripts/ – Support utilities, such as acronym allowlist maintenance.
  • Makefile – Common tasks for formatting, linting, typechecking, testing, and validating Markdown and diagrams.

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

stilyagi-0.1.0.tar.gz (41.5 kB view details)

Uploaded Source

Built Distribution

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

stilyagi-0.1.0-py3-none-any.whl (49.3 kB view details)

Uploaded Python 3

File details

Details for the file stilyagi-0.1.0.tar.gz.

File metadata

  • Download URL: stilyagi-0.1.0.tar.gz
  • Upload date:
  • Size: 41.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.11

File hashes

Hashes for stilyagi-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3c28efa306170adf692e732cdfebffbb9bb2674d6735e8ac4b5ca6ae2225e1bb
MD5 2bfbb33671c2bc109552d067b62ab2e5
BLAKE2b-256 9825f34e4f802c1ecc337760cc783e778a94e4cee51c7cf0d32fbcb684302449

See more details on using hashes here.

File details

Details for the file stilyagi-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: stilyagi-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 49.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.11

File hashes

Hashes for stilyagi-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec97bca2bff00e89c807c3b9e779f63cb9fa5c778808a4729ff513bfe084954e
MD5 7dd5b401bc13322bff6d6e478f539c35
BLAKE2b-256 4579f91bfe9aea9f1a59911ecc1b40da76663b52faf52105e1979e6e9497e5ff

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