Skip to main content

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

boox-annotation-parser-0.1.2.tar.gz (195.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

boox_annotation_parser-0.1.2-py2.py3-none-any.whl (235.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file boox-annotation-parser-0.1.2.tar.gz.

File metadata

  • Download URL: boox-annotation-parser-0.1.2.tar.gz
  • Upload date:
  • Size: 195.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.5

File hashes

Hashes for boox-annotation-parser-0.1.2.tar.gz
Algorithm Hash digest
SHA256 662ba8f27123cc4a9bce4dfed1bf34acb4a48b4df67850c394272df1749da20d
MD5 ec62dc850d94b9813dff3cebccd83497
BLAKE2b-256 e9d1ba28495c15948d97b2ce214d3f27716974fa07b0000b5c55c3f1cd336887

See more details on using hashes here.

File details

Details for the file boox_annotation_parser-0.1.2-py2.py3-none-any.whl.

File metadata

  • Download URL: boox_annotation_parser-0.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 235.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.5

File hashes

Hashes for boox_annotation_parser-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 81212b9304aa88ef74ac75a64991415b175c6e54fd5078db0f6af47aaeadfe50
MD5 b6d165d2d6584b6c1fe2c799bde941ac
BLAKE2b-256 603eb5b564846df8ef2c92fefa358feb90a585266ee7911e8327c739ebce5ddf

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page