From 3af8deef830baa47f718af709c3cf192a9e15fa6 Mon Sep 17 00:00:00 2001
From: takunomi-build-bot <build-bot@takunomi.space>
Date: Sat, 26 Oct 2024 15:19:24 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Repository=20layout=20updated=20?=
 =?UTF-8?q?to=20latest=20version?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager
---
 README.md | 26 ++++++++++++++++++++++++++
 setup.py  | 31 +++++++++++++++++++++++++++++--
 2 files changed, 55 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index fa2aa32..9be0388 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,31 @@
 
 
 
+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.
 
 
 ## Dependencies
@@ -15,6 +40,7 @@ pip install -r requirements.txt
 ```
 
 Full list of requirements:
+- [beautifulsoup4](https://pypi.org/project/beautifulsoup4/)
 
 
 ## License
diff --git a/setup.py b/setup.py
index ccaf611..b55bd34 100644
--- a/setup.py
+++ b/setup.py
@@ -11,10 +11,35 @@ from setuptools import setup
 PACKAGE_NAME = 'libpurple_to_markdown'
 
 PACKAGE_DESCRIPTION = """
+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.
 """.strip()
 
 PACKAGE_DESCRIPTION_SHORT = """
-""".strip()
+Libpurple to markdown conversion script.""".strip()
 
 
 def parse_version_file(text: str) -> str:
@@ -29,7 +54,9 @@ with open(PACKAGE_NAME + '/_version.py') as f:
     version = parse_version_file(f.read())
 
 
-REQUIREMENTS_MAIN = []
+REQUIREMENTS_MAIN = [
+    'beautifulsoup4',
+]
 REQUIREMENTS_TEST = []