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

🤖 Repository layout updated to latest version

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-11-21 19:44:29 +01:00
parent 52d4aacb11
commit 39a25ef697
2 changed files with 56 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -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

32
setup.py
View File

@ -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 = """