Skip to main content

Divengine Python Vault – Generates Obsidian vaults from Python projects

Project description

🧠 Divengine Python Vault – PyVault

PyVault is a Python-powered documentation generator that transforms any Python project into a structured Obsidian vault.

It extracts all classes, functions, and modules, maps their relationships, and builds a fully browseable knowledge graph of the codebase.

PyVault Screenshot


✨ Features

  • Parses your Python project using Python’s ast module
  • Extracts:
    • 📦 Modules (.py files)
    • 🧩 Functions and methods
    • 🏷️ Classes (including inheritance, methods, and properties)
    • 🔗 Function calls between elements (uses)
  • Generates Markdown files for all entities, with proper nesting
  • Preserves the original folder structure
  • Uses Obsidian-style [[wiki links]] to interconnect everything

Obsidian Graph Example


🔧 Usage

📦 Option 1: Clone and run

git clone https://github.com/divengine/pyvault.git
cd pyvault
python pyvault.py ../your_project/ ../vault_output/

🐍 Option 2: Install via pip

pip install divengine-pyvault
pyvault ../your_project/ ../vault_output/

🗂️ Output Example

After running, the tool generates an Obsidian vault like this:

vault_output/
├── module_a.md
├── module_b/
│   ├── imports.md
│   └── MyClass/
│       ├── method_one.md
│       └── method_two.md

Each .md file includes:

  • File or object name
  • Location in the source project
  • Extracted arguments
  • Docstrings (if any)
  • Relationships (uses, inheritance, etc.)

📄 License

MIT License © Divengine Software Solutions

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

divengine_pyvault-1.0.2.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

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

divengine_pyvault-1.0.2-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file divengine_pyvault-1.0.2.tar.gz.

File metadata

  • Download URL: divengine_pyvault-1.0.2.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for divengine_pyvault-1.0.2.tar.gz
Algorithm Hash digest
SHA256 c7b14a31528acb33bb06cff1f47ce6b9df476661ce2b65dca8892733dc39f5fc
MD5 169652c2d05102f63ebbd87ace0e50a7
BLAKE2b-256 3ceec35fc60c4b9f8ff2f3440dc8d9547438c73bf222aa16e4d37ec67d543824

See more details on using hashes here.

File details

Details for the file divengine_pyvault-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for divengine_pyvault-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c3a0259887d53a3d6356dcb4d5097b3ea24ef16a2d5177ca2a53ab1177536bef
MD5 09ebab439330e10bf1e0f7a03e1304e6
BLAKE2b-256 9003d95d92206baebcb585e5a1de31354304472a960b4f319e42e2f244510587

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