vcf-to-obsidian-vcf-contacts

User Guide:

  • Installation
    • Python Implementation
      • Option 1: Install with pip (Recommended)
      • Option 2: Install with pipx (For CLI tools)
      • Option 3: Development Installation
    • Bash Implementation (No Dependencies)
  • Usage
    • Bash Script
    • Python Script
    • Examples
    • Command Line Options
    • Template Output
  • Integration
    • vdirsyncer Integration
      • Configuration
      • Configuration Parameters
      • Customizing Paths
      • Workflow
      • Alternative Installation Methods
      • Troubleshooting
      • Additional Options
  • 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
      • Test Structure
      • Running Bash Tests
        • Run All Tests
        • Run Individual Test Files
        • Using Make Commands
      • Test Output
      • Test Data
        • VCF Test Files
      • Requirements
      • Adding New Tests
      • Test Conventions

API Reference:

  • vcf_to_obsidian
    • Submodules
      • vcf_to_obsidian.cli
        • Functions
        • Module Contents
      • vcf_to_obsidian.filename_generator
        • Classes
        • Module Contents
      • vcf_to_obsidian.markdown_writer
        • Classes
        • Module Contents
      • vcf_to_obsidian.vcf_converter
        • Classes
        • Module Contents
      • vcf_to_obsidian.vcf_reader
        • Classes
        • Module Contents
    • Classes
    • Package Contents
      • VCFReader
        • VCFReader.is_valid_uuid()
        • VCFReader.read_vcf_file()
      • MarkdownWriter
        • MarkdownWriter.generate_obsidian_markdown()
      • FilenameGenerator
        • FilenameGenerator.generate_filename()
        • FilenameGenerator._clean_filename()
        • FilenameGenerator.find_existing_files_with_uid()
      • VCFConverter
        • VCFConverter.reader
        • VCFConverter.writer
        • VCFConverter.filename_gen
        • VCFConverter._extract_rev_timestamp_from_markdown()
        • VCFConverter._should_skip_conversion()
        • VCFConverter.convert_vcf_to_markdown()
        • VCFConverter.convert_vcf_files_from_sources()
        • VCFConverter.process_tasks()
vcf-to-obsidian-vcf-contacts
  • Python Module Index

Python Module Index

v
 
v
- vcf_to_obsidian
    vcf_to_obsidian.cli
    vcf_to_obsidian.filename_generator
    vcf_to_obsidian.markdown_writer
    vcf_to_obsidian.vcf_converter
    vcf_to_obsidian.vcf_reader

© Copyright 2025, Ian Dennis Miller.

Built with Sphinx using a theme provided by Read the Docs.