Skip to main content

A two-pane terminal outline browser for Python modules.

Project description

pyoverview

pyoverview is a small terminal outline browser for Python files. It parses a module with Python's ast module and opens a two-pane TUI:

  • left pane: classes, functions, async functions, and nested definitions
  • right pane: source code, automatically scrolled to the selected symbol

Install

uvx pyoverview path/to/module.py

If you are developing locally:

uv run pyoverview path/to/module.py

Keys

  • Up / Down, k / j: move through the outline
  • PageUp / PageDown: scroll code
  • g / G: jump to first / last outline item
  • Enter: center the selected symbol in the code pane
  • r: reload the file from disk
  • q: quit

Non-interactive Use

pyoverview --print path/to/module.py

This prints the outline without opening the TUI.

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

pyoverview-0.1.0.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

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

pyoverview-0.1.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyoverview-0.1.0.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.24 {"installer":{"name":"uv","version":"0.9.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pyoverview-0.1.0.tar.gz
Algorithm Hash digest
SHA256 80a4bf405c0868c9afa865ba4052555adbd4e79bad6522b41a47e02a7dee3db1
MD5 efff79e6cc64d5dfe366bd0ba7edb38a
BLAKE2b-256 44570aad31f4feeb6df33f5cfb1ac8a01732f6465a18070bf66e20037d96b96b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyoverview-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.24 {"installer":{"name":"uv","version":"0.9.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pyoverview-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 905d180d2baf6ae049ede436d9b95fdc4cf387f2ae30b4acd4ae8736a8fdbbe3
MD5 d8f36f285945b64fc6f6ce33ee988472
BLAKE2b-256 13de5ccf9aafdeba4acdf69ade60ea6b329e385d9969a7274d627af94be9fb75

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