Compare commits
2 Commits
52d4aacb11
...
1406b0666d
Author | SHA1 | Date | |
---|---|---|---|
1406b0666d | |||
39a25ef697 |
32
README.md
32
README.md
|
@ -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
|
||||||
|
|
|
@ -1 +1 @@
|
||||||
__version__ = '0.1.5'
|
__version__ = '0.1.6'
|
||||||
|
|
32
setup.py
32
setup.py
|
@ -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 = """
|
||||||
|
|
Loading…
Reference in New Issue
Block a user