57 lines
2.3 KiB
Markdown
57 lines
2.3 KiB
Markdown
# BookStack-Python-exporter
|
|
Customizable script for exporting notes from BookStack through API
|
|
|
|
#### Features:
|
|
- export keeping the tree structure by making folders from Shelves, Books and Chapters
|
|
- export multiple formats at once
|
|
- export at multiple levels at once (export Books or/and Chapters or/and Pages as files)
|
|
- customizable path for placing exported notes
|
|
- authorization token is loaded from txt file
|
|
|
|
Requirements:
|
|
- Python at least in version 3.6
|
|
|
|
Full example on how to use the script:
|
|
1. Clone the repo
|
|
2. next to the script place token.txt file containing token id and token secret in format: TOKEN_ID:TOKEN_SECRET
|
|
3. in the same directory run the command, specifying your app domain with https prefix (every parameter is optional as it have default value, this is a full possible example):
|
|
```bash
|
|
python exporter.py \
|
|
-H https://wiki.example.com \
|
|
-f pdf,md,plaintext,html \
|
|
-l pages,chapters,books
|
|
-t ./token.txt \
|
|
-V debug \
|
|
-p ./
|
|
```
|
|
|
|
Customization:
|
|
```text
|
|
options:
|
|
-p PATH, --path PATH Path where exported files will be placed.
|
|
Default: .
|
|
-t TOKEN_FILE, --token-file TOKEN_FILE
|
|
File containing authorization token in format TOKEN_ID:TOKEN_SECRET
|
|
Default: ./token.txt
|
|
-H HOST, --host HOST Your domain with protocol prefix, example: https://example.com
|
|
Default: https://localhost
|
|
-f FORMATS, --formats FORMATS
|
|
Coma separated list of formats to use for export.
|
|
Available ones: markdown,plaintext,pdf,html
|
|
default: markdown
|
|
-l LEVEL, --level LEVEL
|
|
Coma separated list of levels at which should be export performed.
|
|
Available levels: ['pages', 'chapters', 'books']
|
|
Default: pages
|
|
-V LOG_LEVEL, --log-level LOG_LEVEL
|
|
Set verbosity level.
|
|
Available levels: dict_keys(['debug', 'info', 'warning', 'error'])
|
|
Default: info
|
|
|
|
```
|
|
|
|
### TODO:
|
|
- ~~choosing verbosity level through command line parameter~~ Done
|
|
- ~~choosing on what level should the notes be exported (Books, Chapters, Pages)~~ Done
|
|
- WIP: choosing if update note file only if the last edit timestamp from API is later that the local file timestamp
|
|
- suggestions?
|