From 39a25ef697ae21471da1f74d4e787ebd9040a2d2 Mon Sep 17 00:00:00 2001 From: takunomi-build-bot Date: Thu, 21 Nov 2024 19:44:29 +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 | 32 ++++++++++++++++++++++++++++---- setup.py | 32 ++++++++++++++++++++++++++++---- 2 files changed, 56 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 61c286c..9764479 100644 --- a/README.md +++ b/README.md @@ -32,18 +32,42 @@ Matrix. ## Usage -From the repository root: +There are two main import patterns: + +- One-off archival import: For when you have a large set of messages to import + for a service that you don't use very much anymore. +- Recurring import: For when you are still using the service, and want to + import on a recurring basis. + +This program will be default not overwrite existing files, as the user might +have modified it. + +Special consideration must be taking for recurring imports if you expect to be +modifying the resulting files, for example if you are inserting links +using Obsidian's unlinked mentions feature. You might want to use the +`--skip-this-period` flag to avoid importing the current period until it has +become the last period. That way you won't accidentally modify the log, because +it has been finalized. + +### One-off + +This is the recommended command for the one-off case: ```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 the formatting code. +### Recurring + +This is the recommended command for the recurring import case: + +```bash +python -m libpurple_to_markdown LOG_DIRECTORY --output OUTPUT_FOLDER --skip-this-period --period month +``` ## TODO -- [ ] Decode MMS parts and reconstruct image attachments. +- [ ] SyncTech: Decode MMS parts and reconstruct image attachments. ## Dependencies diff --git a/setup.py b/setup.py index 5bb2bf5..9503ed3 100644 --- a/setup.py +++ b/setup.py @@ -39,18 +39,42 @@ Matrix. ## Usage -From the repository root: +There are two main import patterns: + +- One-off archival import: For when you have a large set of messages to import + for a service that you don't use very much anymore. +- Recurring import: For when you are still using the service, and want to + import on a recurring basis. + +This program will be default not overwrite existing files, as the user might +have modified it. + +Special consideration must be taking for recurring imports if you expect to be +modifying the resulting files, for example if you are inserting links +using Obsidian's unlinked mentions feature. You might want to use the +`--skip-this-period` flag to avoid importing the current period until it has +become the last period. That way you won't accidentally modify the log, because +it has been finalized. + +### One-off + +This is the recommended command for the one-off case: ```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 the formatting code. +### Recurring + +This is the recommended command for the recurring import case: + +```bash +python -m libpurple_to_markdown LOG_DIRECTORY --output OUTPUT_FOLDER --skip-this-period --period month +``` ## TODO -- [ ] Decode MMS parts and reconstruct image attachments. +- [ ] SyncTech: Decode MMS parts and reconstruct image attachments. """.strip() PACKAGE_DESCRIPTION_SHORT = """