Skip to main content

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

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.

Metadata

Release files for boox-annotation-parser 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for boox-annotation-parser 0.1.2
File Size Uploaded Provenance Actions
boox-annotation-parser-0.1.2.tar.gz 195.5 kB Without provenance Details for boox-annotation-parser-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for boox-annotation-parser 0.1.2
File Interpreter ABI Platform Actions
boox_annotation_parser-0.1.2-py2.py3-none-any.whl Python 2, Python 3 none any Details for boox_annotation_parser-0.1.2-py2.py3-none-any.whl

Total release size: 430.9 kB

Release files / boox-annotation-parser-0.1.2.tar.gz

Download URL boox-annotation-parser-0.1.2.tar.gz
Size 195.5 kB
Tags Source
SHA-256 checksum
How to use checksums
662ba8f27123cc4a9bce4dfed1bf34acb4a48b4df67850c394272df1749da20d
BLAKE2b-256 checksum
How to use checksums
e9d1ba28495c15948d97b2ce214d3f27716974fa07b0000b5c55c3f1cd336887
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / boox_annotation_parser-0.1.2-py2.py3-none-any.whl

Download URL boox_annotation_parser-0.1.2-py2.py3-none-any.whl
Size 235.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
81212b9304aa88ef74ac75a64991415b175c6e54fd5078db0f6af47aaeadfe50
BLAKE2b-256 checksum
How to use checksums
603eb5b564846df8ef2c92fefa358feb90a585266ee7911e8327c739ebce5ddf
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for boox-annotation-parser 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page