Installation¶

From PyPI¶

pip install obsidian-import

Optional backends¶

Install extras for additional backend support:

# markitdown — fallback for HTML, CSV, and other formats
pip install obsidian-import[markitdown]

# docling — high-quality ML-based extraction for complex layouts
pip install obsidian-import[docling]

Development Setup¶

Clone the repository and install with pixi:

git clone https://github.com/neuralsignal/obsidian-import.git
cd obsidian-import
pixi install

Pre-commit hooks¶

Install pre-commit hooks for automatic linting and formatting:

pixi run pre-commit-install

Running tests¶

pixi run test

Linting and formatting¶

pixi run lint
pixi run format-check
pixi run format

Requirements¶

Python >= 3.12
Core dependencies are installed automatically: pyyaml, click, pdfplumber, pypdf, defusedxml, python-pptx, openpyxl