Compact Python symbol manifests for codebases
Project description
suoyin
suoyin generates a compact Markdown manifest of Python modules, classes, members, and functions.
It is designed for fast codebase inspection and for feeding a high-signal summary into LLM workflows.
Repository: https://github.com/alexdong/suoyin
Features
- Recursively scans a project directory
- Respects
.gitignoreand.ignore - Skips test files and
conftest.py - Renders compact function signatures such as
def func(a: int) -> str - Expands classes to show both members and methods
Usage
uvx suoyin
uvx suoyin path/to/project
Local development:
uv run suoyin
uv run suoyin ../some-project
uv run python -m suoyin --help
Example
# Manifest
## pkg.module (pkg/module.py)
classes:
- class Widget @L10
members:
- name: str @L11
functions:
- def render(self) -> str @L14
functions:
- def make_widget(name: str) -> Widget @L21
Build And Publish
uv build
uv publish
If you have not published with uv before, configure a PyPI token first.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file suoyin-0.1.0.tar.gz.
File metadata
- Download URL: suoyin-0.1.0.tar.gz
- Upload date:
- Size: 6.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f1eacc4f488528e71f9121f3c682595be5d4ad96dd6185d4a09c5e862cacec84
|
|
| MD5 |
eb94e3a01db43d0e4a21675dca250823
|
|
| BLAKE2b-256 |
183ab2c93455f3ec68b2e0306712fcb0fa04ff1afa2775c1440043853438addd
|
File details
Details for the file suoyin-0.1.0-py3-none-any.whl.
File metadata
- Download URL: suoyin-0.1.0-py3-none-any.whl
- Upload date:
- Size: 6.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dd6d3efb266424051e4cd87b5eb2c78ae9712b1ff49bb72a6b3768ea7e569981
|
|
| MD5 |
a75dfb4e71443eb8575716596838a154
|
|
| BLAKE2b-256 |
6926624b300ad17d3ed40257bffb538421601d3a6b9b4eca0177f78e1728e71e
|