Documentation

libpurple_to_markdown/__init__.py

@@ -1,3 +1,29 @@
+"""Libpurple to markdown conversion script.
+
+Conversion script for HTML-based logs from [Pidgin/Libpurple](https://pidgin.im/) chat program.
+
+**This is an one-off script, and is not actively maintained.**
+
+## Motivation
+
+I recently discovered [Obsidian](https://obsidian.md) and liked the prospect of
+cross-referencing my notes with my old chat logs. Libpurple uses HTML logs if
+you haven't configured it to something else (which I haden't).
+
+I no longer use IRC or Pidgin as my entire friend group have switched to using
+Matrix.
+
+## Usage
+
+From the repository root:
+
+```bash
+python -m libpurple_to_markdown LOG_DIRECTORY --output OUTPUT_FOLDER
+```
+
+It was made specifically for import into Obsidian, so it might not suite your
+purposes, but it shouldn't be too difficult to adjust.
+"""
 import dataclasses
 import datetime
 from collections.abc import Iterator, Iterable