boox-annotation-parser

====================== Boox Annotation Parser

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

.. code-block:: python

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.