1
0

Compare commits

..

2 Commits

Author SHA1 Message Date
1406b0666d 🤖 Bumped version to 0.1.6
All checks were successful
Package Python / Package (push) Successful in 24s
Verify Python project can be installed, loaded and have version checked / Test (push) Successful in 22s
Run Python tests (through Pytest) / Test (push) Successful in 23s
This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager
2024-11-21 19:44:50 +01:00
39a25ef697 🤖 Repository layout updated to latest version
This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager
2024-11-21 19:44:29 +01:00
3 changed files with 57 additions and 9 deletions

View File

@ -32,18 +32,42 @@ Matrix.
## Usage ## 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 ```bash
python -m libpurple_to_markdown LOG_DIRECTORY --output OUTPUT_FOLDER python -m libpurple_to_markdown LOG_DIRECTORY --output OUTPUT_FOLDER
``` ```
It was made specifically for import into Obsidian, so it might not suite your ### Recurring
purposes, but it shouldn't be too difficult to adjust the formatting code.
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 ## TODO
- [ ] Decode MMS parts and reconstruct image attachments. - [ ] SyncTech: Decode MMS parts and reconstruct image attachments.
## Dependencies ## Dependencies

View File

@ -1 +1 @@
__version__ = '0.1.5' __version__ = '0.1.6'

View File

@ -39,18 +39,42 @@ Matrix.
## Usage ## 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 ```bash
python -m libpurple_to_markdown LOG_DIRECTORY --output OUTPUT_FOLDER python -m libpurple_to_markdown LOG_DIRECTORY --output OUTPUT_FOLDER
``` ```
It was made specifically for import into Obsidian, so it might not suite your ### Recurring
purposes, but it shouldn't be too difficult to adjust the formatting code.
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 ## TODO
- [ ] Decode MMS parts and reconstruct image attachments. - [ ] SyncTech: Decode MMS parts and reconstruct image attachments.
""".strip() """.strip()
PACKAGE_DESCRIPTION_SHORT = """ PACKAGE_DESCRIPTION_SHORT = """