vcf-to-obsidian-vcf-contacts documentation

This is the API documentation for vcf-to-obsidian-vcf-contacts, a Python module that batch-converts VCF files into Markdown files that are compatible with the obsidian-vcf-contacts plugin for ObsidianMD.

Overview

vcf-to-obsidian-vcf-contacts provides a comprehensive solution for converting VCF (vCard) contact files into Markdown format suitable for use in Obsidian with the vcf-contacts plugin. The library includes:

• VCF file reading and parsing

• Markdown content generation with frontmatter

• Intelligent filename generation

• Command-line interface

• Batch processing capabilities

User Guide:

• Installation
  • Python Implementation
  • Bash Implementation (No Dependencies)
• Usage
  • Bash Script
  • Python Script
  • Examples
  • Command Line Options
  • Template Output
• Integration
  • vdirsyncer Integration
• Implementation Comparison
  • When to use the bash script:
  • When to use the Python script:
• VCF Support
  • vCard 4.0 Support
  • Parsing Engine
  • Filename Generation

Development:

• Development and Maintenance
  • Quick Setup
  • Available Make Targets
  • Dependencies
  • Error Handling
• Testing
  • Running Tests
  • Test Organization
  • Test Coverage
  • Bash Tests

API Reference:

• vcf_to_obsidian
  • Submodules
  • Classes
  • Package Contents

Indices and tables

• Index

• Module Index

• Search Page