Python Viewer

by Viggo Meesters
5
4
3
2
1
Score: 52/100

Description

Read-only Python source and structure viewer for Obsidian.

Reviews

No reviews yet.

Stats

1
stars
2,570
downloads
0
forks
165
days
3
days
3
days
3
total PRs
0
open PRs
0
closed PRs
3
merged PRs
2
total issues
0
open issues
2
closed issues
11
commits

Latest Version

4 days ago

Changelog

Maintenance 0.1.2: checked on Obsidian 1.15.1 desktop (macOS arm64), with unchanged runtime code. Adds the checked-version documentation and reproducible official lint tooling while retaining existing repository guards.

Exact reviewed source: fe19895e4f5862a6b0b847ef1823faedf81ea457. The QA document records actual fixture oracles, exercised actions, additional smoke coverage and limits. Clean local validation and independent source/runtime/visual review passed; the official exact-SHA source preview completed.

Mobile, minimum-version, native resize and real authentication/keychain behavior were not verified. Final public asset readback, official release review and fresh Community installation are checked separately.

README file from

Github

Python Viewer

Python Viewer is a read-only plugin for browsing .py files as source plus a compact structure outline. It is built for quick inspection of scripts, generated code, migration utilities, and agent output without turning the vault into an IDE.

Python Viewer preview

Features

  • Opens .py files in a dedicated view.
  • Shows a structure view with imports, decorators, classes, functions, methods, and top-level constants.
  • Provides a source view with line numbers and lightweight Python syntax highlighting.
  • Filters symbols and source lines by name, kind, detail, and source text.
  • Jumps from a symbol to its source line.
  • Reports parse diagnostics such as missing colons on def or class lines.
  • Keeps source view available when structure parsing is incomplete.
  • Applies a 10,000 line render cap to keep large generated scripts responsive.
  • Stays read-only by design: it never writes back to Python files and never runs Python code.

Why read-only?

This plugin is for inspection. It does not execute code, start subprocesses, lint, format, refactor, sort imports, or save changes. Editing and execution belong in a code editor or terminal where project context, environments, and safeguards are explicit.

Parser strategy

Python Viewer v0.1 uses a lightweight local symbol parser. It detects common imports, decorators, classes, functions, methods, and top-level constants while avoiding detections inside comments and triple-quoted strings. It is intentionally not a full Python AST parser.

When parsing is incomplete or a syntax diagnostic is found, the source view remains available and line numbers are preserved.

Large files

Python files can become large when generated by agents or migration tooling. Python Viewer renders the first 10,000 lines and reports how many lines were skipped.

Privacy and security

Python Viewer does not make network requests and does not send vault content to external services. It does not use the system clipboard, does not write files, and does not execute Python code.

Installation

Community plugin directory

Install from the Obsidian Community directory or search for Python Viewer in Settings → Community plugins → Browse.

Manual installation

  1. Download main.js, manifest.json, and styles.css from the latest release.
  2. Create this folder in your vault: .obsidian/plugins/python-viewer/.
  3. Put the downloaded files in that folder.
  4. Reload the app.
  5. Enable Python Viewer in Settings -> Community plugins.

BRAT installation

For beta testing, install the plugin with BRAT using this repository URL:

https://github.com/viggomeesters/obsidian-python-viewer

Usage

Open any .py file in your vault. The file opens with Python Viewer.

Use the toolbar to:

  • filter symbols and source lines
  • switch between Structure and Source views
  • refresh the file after external changes

Development

npm install
npm run build
npx tsc --noEmit
npm test

Release files

The runtime files are:

  • main.js
  • manifest.json
  • styles.css

Release process

Community plugin files are installed from GitHub releases. For each release:

  1. Update manifest.json, package.json, and versions.json.
  2. Run npm install, npm run build, npx tsc --noEmit, and npm test.
  3. Create a GitHub release whose tag exactly matches manifest.json.version.
  4. Attach main.js, manifest.json, and styles.css as release assets.

The repository includes a GitHub Actions release workflow with artifact attestation support. If GitHub Actions is disabled for the owner account, manual releases are still usable, but automated review may show a recommendation about missing artifact attestations.

Community directory

Python Viewer is listed in the Obsidian Community directory.

License

MIT

Obsidian 1.15.1 assessment: checked source, local results and remaining host validation.