Parse annotation file exports from your Boox device, and transform them into JSON, YAML, or whatever you want.
Project description
Parse annotation file exports from your Onyx Boox device, and transform them into JSON, YAML, or whatever you want.
Free software: MIT license
Installation
pip install boox-annotation-parser
You can also install the in-development version with:
pip install https://github.com/coddingtonbear/boox-annotation-parser/archive/master.zip
Documentation
To use the project from the command-line
Options:
--input: (Default: ‘stdin’) The path to your Boox annotation export file. If unspecified, reads from stdin.
--output: (Default: ‘stdout’) The path to where you’d like your output written to. If unspecified, writes to stdout.
--format: (Default: ‘yaml’) The format you’d like your annotations written out in. Options include: - yaml - json - nljson
boox-annotation-parser --input=/path/to/boox/export.txt --output=/path/to/write/output/to --format=yaml
To use the project as a library
from boox_annotation_parser import parser
with open('/path/to/boox/export.txt', 'r') as inf:
parsed = parser.get_annotations(inf)Development
To run the tests run:
pytest
Changelog
0.1.0 (2021-08-19)
First release on PyPI.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for boox-annotation-parser-0.1.2.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 662ba8f27123cc4a9bce4dfed1bf34acb4a48b4df67850c394272df1749da20d |
|
| MD5 | ec62dc850d94b9813dff3cebccd83497 |
|
| BLAKE2b-256 | e9d1ba28495c15948d97b2ce214d3f27716974fa07b0000b5c55c3f1cd336887 |
Hashes for boox_annotation_parser-0.1.2-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 81212b9304aa88ef74ac75a64991415b175c6e54fd5078db0f6af47aaeadfe50 |
|
| MD5 | b6d165d2d6584b6c1fe2c799bde941ac |
|
| BLAKE2b-256 | 603eb5b564846df8ef2c92fefa358feb90a585266ee7911e8327c739ebce5ddf |
