From 5d2dd336972d5c67227ace9a3f4f7194097b1691 Mon Sep 17 00:00:00 2001 From: takunomi-build-bot Date: Thu, 31 Oct 2024 22:38:57 +0100 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 | 19 +++++++++++++++---- ruff.toml | 1 + setup.py | 21 ++++++++++++++++----- 3 files changed, 32 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9be0388..438e896 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,25 @@ -Libpurple to markdown conversion script. +# Markdown Message Conversion. -Conversion script for HTML-based logs from [Pidgin/Libpurple](https://pidgin.im/) chat program. +Conversion script from various messaging formats to markdown. -**This is an one-off script, and is not actively maintained.** +Supported input formats: + +- [Pidgin/Libpurple](https://pidgin.im/) chat program HTML-based logs. **This + backend is not actively maintained.** +- [SyncTech Backup & Restore](https://www.synctech.com.au/sms-backup-restore/) + XML-based backup format. ## Motivation +Messaging applications are mostly good at sending real-time messages to other +people, but they generally do not possess any useful archival features. Most +messages are write-once read-once, and the apps where built for this use case. +More and more through, I am attracted to the prospect of archival; of +understanding who I am and who I _were_ when I wrote those messages. + 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). @@ -28,7 +39,7 @@ 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. +purposes, but it shouldn't be too difficult to adjust the formatting code. ## Dependencies diff --git a/ruff.toml b/ruff.toml index 317a9a2..c397e12 100644 --- a/ruff.toml +++ b/ruff.toml @@ -76,4 +76,5 @@ docstring-code-format = true "S101", # Test Asserts "T201", # Debug prints "PLR2004", # magic-value-comparison + 'SLF001', # Allow access to private members ] diff --git a/setup.py b/setup.py index b55bd34..8d7cbc8 100644 --- a/setup.py +++ b/setup.py @@ -11,14 +11,25 @@ from setuptools import setup PACKAGE_NAME = 'libpurple_to_markdown' PACKAGE_DESCRIPTION = """ -Libpurple to markdown conversion script. +# Markdown Message Conversion. -Conversion script for HTML-based logs from [Pidgin/Libpurple](https://pidgin.im/) chat program. +Conversion script from various messaging formats to markdown. -**This is an one-off script, and is not actively maintained.** +Supported input formats: + +- [Pidgin/Libpurple](https://pidgin.im/) chat program HTML-based logs. **This + backend is not actively maintained.** +- [SyncTech Backup & Restore](https://www.synctech.com.au/sms-backup-restore/) + XML-based backup format. ## Motivation +Messaging applications are mostly good at sending real-time messages to other +people, but they generally do not possess any useful archival features. Most +messages are write-once read-once, and the apps where built for this use case. +More and more through, I am attracted to the prospect of archival; of +understanding who I am and who I _were_ when I wrote those messages. + 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). @@ -35,11 +46,11 @@ 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. +purposes, but it shouldn't be too difficult to adjust the formatting code. """.strip() PACKAGE_DESCRIPTION_SHORT = """ -Libpurple to markdown conversion script.""".strip() +Conversion script from various messaging formats to markdown.""".strip() def parse_version_file(text: str) -> str: