Skip to main content

Divengine Python Vault – Generates Obsidian vaults from Python projects

Project description

Divengine Python Vault

PyPI version

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 divengine/pyvault/core.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.3.tar.gz (8.9 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.3-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: divengine_pyvault-1.0.3.tar.gz
  • Upload date:
  • Size: 8.9 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.3.tar.gz
Algorithm Hash digest
SHA256 39498d61f23b045ecc851f4004a3b7aba518d2725255679d90e683384b5bdf8a
MD5 9a932b274db4891ccbee994e85d15cf3
BLAKE2b-256 bed1c4535cf9917d7f3af297ca741f066b6d92b2a8093f8dab332157907b284f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for divengine_pyvault-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 04f53a06250df61c04f484c4343a5b190eff04c29b657fb8b9a6b875e62374bb
MD5 52960317a03add47ee0449285212325a
BLAKE2b-256 32b842440537d4915428869c3460093862be71add875e4c8de952c09618547a9

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