1
0

Compare commits

..

No commits in common. "1406b0666dc5667b3603bf83f649df186b3233a8" and "52d4aacb11d1489fd104b899a3093ac09df44214" have entirely different histories.

3 changed files with 9 additions and 57 deletions

View File

@ -32,42 +32,18 @@ Matrix.
## Usage ## Usage
There are two main import patterns: From the repository root:
- 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
``` ```
### Recurring 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.
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
- [ ] SyncTech: Decode MMS parts and reconstruct image attachments. - [ ] Decode MMS parts and reconstruct image attachments.
## Dependencies ## Dependencies

View File

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

View File

@ -39,42 +39,18 @@ Matrix.
## Usage ## Usage
There are two main import patterns: From the repository root:
- 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
``` ```
### Recurring 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.
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
- [ ] SyncTech: Decode MMS parts and reconstruct image attachments. - [ ] Decode MMS parts and reconstruct image attachments.
""".strip() """.strip()
PACKAGE_DESCRIPTION_SHORT = """ PACKAGE_DESCRIPTION_SHORT = """