Skip to main content

GitHub Actions badge picker for tt-metal workflows

Project description

tt-badger

Generate GitHub Actions badge Markdown for tenstorrent/tt-metal workflows.

  • Numbering: 1–9, with 0 mapped to the last item (10th)
  • Instant toggling: press digits to toggle; Enter to finish
  • Persists selection in ~/.tt-badges.json unless --select is provided
  • Always includes ?branch=<branch> in badge.svg URLs

Install

  • pip: pip install tt-badger
  • pipx (recommended for CLIs): pipx install tt-badger

This installs the tt-badger command.

Usage

  • Interactive mode:

    • tt-badger --branch main
    • Press 0–9 to toggle workflows; press Enter to print selected badges
  • Non-interactive pre-selection (skips the menu):

    • tt-badger -b main --select 1290 (toggles 1, 2, 9, and last)

If no --select is given, the previously saved selection (from ~/.tt-badges.json) is used as a starting point.

Example output (Markdown):

[![All post-commit tests](https://github.com/tenstorrent/tt-metal/actions/workflows/all-post-commit-workflows.yaml/badge.svg?branch=main)](https://github.com/tenstorrent/tt-metal/actions/workflows/all-post-commit-workflows.yaml)
[![Blackhole post-commit tests](https://github.com/tenstorrent/tt-metal/actions/workflows/blackhole-post-commit.yaml/badge.svg?branch=main)](https://github.com/tenstorrent/tt-metal/actions/workflows/blackhole-post-commit.yaml)

CLI Options

  • -b, --branch <name>: Branch name (e.g., main or feature/foo). Required.
  • -s, --select <digits>: Digits 1–9 (and 0 for the last) to pre-toggle and skip interaction.

Development

  • Editable install: pip install -e .
  • Run from source:
    • python -m tt_badger.cli -b main
    • or ./badger -b main

Release (CI to PyPI)

  • This repo publishes to PyPI via GitHub Actions using PyPI Trusted Publishing (OIDC) only — no secrets required.
  • On PyPI, add a Trusted Publisher for this repo with workflow path .github/workflows/publish.yml.
  • To release:
    1. Bump __version__ in src/tt_badger/__init__.py and pyproject.toml.
    2. Create a Git tag like v0.1.0 and draft a GitHub Release.
    3. Publish the Release to trigger the PyPI workflow.

License: Apache 2.0 (see LICENSE).

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

tt_badger-0.1.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

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

tt_badger-0.1.0-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tt_badger-0.1.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tt_badger-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3ca38499dc4aea206de144e49c6a2006d6fb8501b6c9316ab89f4a280474e55a
MD5 450b38563c46b2048701ee757490eebd
BLAKE2b-256 eafdea35c649e070dc03c2d2e6033277de715872207c9d97cdd0a2a1c61f94b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for tt_badger-0.1.0.tar.gz:

Publisher: publish.yml on yieldthought/tt-badger

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: tt_badger-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tt_badger-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb3f9c84018f5694e410b572370c07d7cf281dbd73ef5b505fdf68f40d84cd1e
MD5 23fb20f14aab02abb6cc862180001a8a
BLAKE2b-256 038ff4c644a43560b62f7a3b984e1b7f5a7119bebd12d4f3284a180a5c692e0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for tt_badger-0.1.0-py3-none-any.whl:

Publisher: publish.yml on yieldthought/tt-badger

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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