Jmaa/libpurple-to-markdown
1
0
Fork 0
Code Actions Packages

🤖 Repository layout updated to latest version
Some checks are pending
Run Python tests (through Pytest) / Test (push) Waiting to run
Details
Verify Python project can be installed, loaded and have version checked / Test (push) Waiting to run
Details

Browse Source 
This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager
This commit is contained in:
Takunomi Automaticus, The 2nd 2024-10-31 22:38:57 +01:00
parent 577b229a0a
commit 5d2dd33697
3 changed files with 32 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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 ## 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 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 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). 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 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 ## Dependencies

1
ruff.toml
View File

@ -76,4 +76,5 @@ docstring-code-format = true
"S101", # Test Asserts "S101", # Test Asserts
"T201", # Debug prints "T201", # Debug prints
"PLR2004", # magic-value-comparison "PLR2004", # magic-value-comparison
'SLF001', # Allow access to private members
] ]

21
setup.py
View File

@ -11,14 +11,25 @@ from setuptools import setup
PACKAGE_NAME = 'libpurple_to_markdown' PACKAGE_NAME = 'libpurple_to_markdown'
PACKAGE_DESCRIPTION = """ 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 ## 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 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 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). 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 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() """.strip()
PACKAGE_DESCRIPTION_SHORT = """ 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: def parse_version_file(text: str) -> str: