Skip to main content

A Textual TUI for rediscovering what your Python scripts do — their arguments, inputs, and outputs

Project description

belfry

Ring a bell. A Textual TUI for rediscovering what your Python scripts actually do.

belfry in action

You know the folder: dozens of .py files accumulated over months — mainline analyses, throwaway one-offs, and half-remembered experiments. Which ones take arguments? What files do they read? What do they write? belfry answers those questions at a glance, without you opening a single file.

A belfry is a bell tower — and, as in "bats in the belfry," a place where things hang half-forgotten until you go and ring them.

What it shows

Run belfry in any folder. It lists every .py file (recursively, honoring .gitignore) with a script-type badge, last-modified date, and git provenance. Select a file and belfry shows you:

  • the CLI arguments it accepts — parsed from argparse / click / typer, or sys.argv indexing, even when there's no --help text to be found;
  • the hardcoded input filenames it reads (pd.read_csv, open, xr.open_dataset, np.load, …);
  • the output files it writes (.to_csv, plt.savefig, json.dump, gmsh.write, …);
  • its docstring and leading comments;
  • a script-type badgecli, cell-script (Jupyter # %%), script, or error;
  • the module-level constants ("knobs") for scripts driven by hardcoded values instead of CLI flags;
  • a syntax-highlighted source preview.

It even resolves f-strings and Path(...) expressions, so f"./runs/{RUN_NAME}/" shows up as the real path and unresolved values are clearly flagged.

How it works

belfry reads each script with Python's ast module and never executes it — safe to point at code you don't trust or barely remember. Analysis and git lookups happen lazily as you move through the list and are cached, so it stays responsive in large trees. Git provenance falls back cleanly to filesystem mtime when a file is untracked or you're not in a git repo.

Install

belfry is not on PyPI yet. Install from source:

git clone git@github.com:brendanjmeade/belfry.git
cd belfry
pip install -e .

Requires Python 3.10+ (the only runtime dependency is textual).

Usage

belfry [PATH] [--no-recurse]
  • PATH — directory to scan (defaults to the current directory).
  • --no-recurse — only scan the top level instead of descending into subdirectories.

You can also run it as a module: python -m belfry.

Key bindings

Key Action
j / k, arrows navigate the file list (or scroll the details when the lower pane is focused)
J / K jump focus to the lower / upper pane
h / l switch tabs in the lower pane (Summary / Source)
/ filter files by name
r toggle recursion / rescan
enter open the selected file in $EDITOR
q quit

Development

pip install -e ".[dev]"
pytest

The static analyzer (src/belfry/analyzer.py) is covered by a focused test suite with fixtures for each pattern it handles.

License

Not yet licensed — a license will be added before the first release.

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

belfry-0.1.0.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

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

belfry-0.1.0-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: belfry-0.1.0.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for belfry-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9f12980fcc24edbcfb425414f15d29ef849abbf279c362683cbfba0f34b31737
MD5 b60d8dc47c2d9b859b78b500ec3450ea
BLAKE2b-256 39d617ad1d8891bdcdb9840759b4fe39b2042fa6ce0337a5e86075069393c4cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: belfry-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 24.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for belfry-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79acafd2cbb9518d7b03c51a8d7aca456cb01e2294c722b091c9cae55bc85e61
MD5 406ad1393dba9c117636a3a371231cc8
BLAKE2b-256 a36240b608431e350f2ea3638ccbe140b944dcaf4eece1e06d541c9acbd20819

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