onenote-converter 0.1.2__tar.gz

onenote_converter-0.1.2/CHANGELOG.md

@@ -0,0 +1,73 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project adheres
+to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.2] - 2026-10-27
+
+### Fixed
+
+- Wheels now carry the license text (`dist-info/licenses/LICENSE.python`), as the
+  MIT terms require; `scripts/check.sh` and CI fail if the copy drifts from the
+  repository `LICENSE`.
+
+## [0.1.1] - 2026-10-27
+
+Packaging and verification release; no parser behaviour changed.
+
+### Fixed
+
+- CI could not build the Python extension: `maturin develop` needs a virtualenv,
+  so the workflow now builds a wheel and installs it (the same commands
+  `scripts/check.sh` runs).
+- The sdist no longer carries `.gitignore` or `PLAN.md`.
+
+### Changed
+
+- Python floor is `>= 3.9` everywhere (the abi3 feature matched it).
+- Runner labels are pinned (`ubuntu-24.04`, `macos-15`, `macos-15-intel`,
+  `windows-2025`) so label migrations cannot change the matrix.
+- `scripts/check.sh` reproduces the CI gate, including creating a throwaway
+  virtualenv on a bare checkout and installing the built sdist into a clean one.
+
+## [0.1.0] - 2026-10-26
+
+First release: a CLI, a Rust library and Python bindings over one parser.
+
+### Added
+
+- **Sections** (`.one`): reads `[MS-ONESTORE]` revision stores — header, file node
+  lists, property sets, object spaces, revisions, object groups, file data.
+- **Packages** (`.onepkg`): reads Microsoft Cabinets with stored and MSZIP
+  folders; Quantum and LZX are rejected with a message.
+- **Notebooks** (`.onetoc2`): the table of contents is honoured exactly as given,
+  section groups become subfolders with their own `index.md`, and entries whose
+  file or folder is missing are reported instead of skipped.
+- **Markdown output**: page headings, paragraphs, numbered and bulleted lists
+  with nesting, tables, pictures (extracted with stable deduplicated names),
+  attachments, ink markers, note tags, and inline run formatting (bold, italic,
+  strike, underline, colour, highlight, hyperlinks).
+- **YAML front matter** per page: title, creation and modification dates,
+  authors, page level.
+- **Diagnostics**: `header` and `inspect` commands (object spaces, declarations,
+  property sets, blob ranges, text search, hashed chunk list, transaction log).
+- **Packaged stores** (`[MS-FSSHTTPB]`): data elements, cells, object data and
+  the storage index are translated into the same object model as plain stores.
+- **Python bindings** (`onenote`): `read_section`, `read_notebook`,
+  `read_package` with `Section`/`Page`/`Image`/`Notebook`/`Package`, abi3 wheels
+  for CPython 3.9+.
+- **Machine-readable runs**: `--report` writes a JSON summary, `--strict` turns
+  any warning into a non-zero exit status.
+
+### Notes
+
+- Encrypted sections are detected and reported; their content is not decrypted.
+- Format decisions and the measurements behind them are recorded in `PLAN.md`.
+
+[Unreleased]: https://github.com/wsmontes/one-note-converter/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/wsmontes/one-note-converter/releases/tag/v0.1.2
+[0.1.1]: https://github.com/wsmontes/one-note-converter/releases/tag/v0.1.1
+[0.1.0]: https://github.com/wsmontes/one-note-converter/releases/tag/v0.1.0

onenote_converter-0.1.2/Cargo.lock

@@ -0,0 +1,203 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "autocfg"
+version = "1.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600"
+
+[[package]]
+name = "flate2"
+version = "1.1.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6e634e2e0ebac1ee034020da1ca582e17ffe4e0f5e985823721e168928136dcb"
+dependencies = [
+ "zlib-rs",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a37b2691796cffeb8a8cd305ac66e65841559f147f4e63231d0eafa4db5384d1"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.191"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "65cd87c9a6d60536580b316ad985726104730a5151c99845f2490428ef91240a"
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "one-note-converter"
+version = "0.1.2"
+dependencies = [
+ "flate2",
+]
+
+[[package]]
+name = "onenote-py"
+version = "0.1.2"
+dependencies = [
+ "one-note-converter",
+ "pyo3",
+]
+
+[[package]]
+name = "portable-atomic"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "05c8b63e8d9609db387f0324918f81d68fe27748f084ef092fb35954d0539a85"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.107"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7778bffd85cf38175ac1f545509665d0b9b92a198ca7941f131f85f7a4f9a872"
+dependencies = [
+ "cfg-if",
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "94f6cbe86ef3bf18998d9df6e0f3fc1050a8c5efa409bf712e661a4366e010fb"
+dependencies = [
+ "once_cell",
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e9f1b4c431c0bb1c8fb0a338709859eed0d030ff6daa34368d3b152a63dfdd8d"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fbc2201328f63c4710f68abdf653c89d8dbc2858b88c5d88b0ff38a75288a9da"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fca6726ad0f3da9c9de093d6f116a93c1a38e417ed73bf138472cf4064f72028"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cf54715a573b99ac80df0bc206da022bcd442c974952c7b9720069370852e21f"
+
+[[package]]
+name = "syn"
+version = "2.0.119"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.12.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.27"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a2c754d6c33795a1c324727428e5a7dedb5b06195f9890bdbcba760d3e246563"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"
+
+[[package]]
+name = "zlib-rs"
+version = "0.6.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b268e58e7c693d7c271f93ffc4ba3b380412554231c85bf61ca7af91042a4112"

onenote_converter-0.1.2/Cargo.toml

@@ -0,0 +1,38 @@
+[workspace]
+members = [".", "python"]
+resolver = "2"
+
+[workspace.package]
+version = "0.1.2"
+edition = "2021"
+rust-version = "1.82"
+license = "MIT"
+repository = "https://github.com/wsmontes/one-note-converter"
+homepage = "https://github.com/wsmontes/one-note-converter"
+authors = ["Wagner Montes <wmontes@gmail.com>"]
+
+[package]
+name = "one-note-converter"
+description = "Convert Microsoft OneNote .one sections, .onetoc2 notebooks and .onepkg packages to Markdown"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+repository.workspace = true
+homepage.workspace = true
+authors.workspace = true
+documentation = "https://docs.rs/one-note-converter"
+readme = "README.md"
+keywords = ["onenote", "markdown", "ms-onestore", "converter", "notes"]
+categories = ["parser-implementations", "command-line-utilities"]
+exclude = ["python", ".github", "target"]
+
+[[bin]]
+name = "onenote2md"
+path = "src/main.rs"
+
+[dependencies]
+flate2 = { version = "1", default-features = false, features = ["zlib-rs"] }
+
+[package.metadata.docs.rs]
+all-features = true

onenote_converter-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wagner Montes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

onenote_converter-0.1.2/LICENSE.python

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wagner Montes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

onenote_converter-0.1.2/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: onenote-converter
+Version: 0.1.2
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+License-File: LICENSE.python
+Summary: Read Microsoft OneNote .one sections, .onetoc2 notebooks and .onepkg packages in Python
+Keywords: onenote,markdown,ms-onestore,converter,notebook
+Home-Page: https://github.com/wsmontes/one-note-converter
+Author-email: Wagner Montes <wmontes@gmail.com>
+License-Expression: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/wsmontes/one-note-converter/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/wsmontes/one-note-converter/blob/main/python/README.md
+Project-URL: Homepage, https://github.com/wsmontes/one-note-converter
+Project-URL: Issues, https://github.com/wsmontes/one-note-converter/issues
+Project-URL: Repository, https://github.com/wsmontes/one-note-converter
+
+# onenote — Python bindings
+
+`pip install onenote-converter` (the distribution is `onenote-converter`, the module is `onenote`).
+
+Python API over the same Rust parser the `onenote2md` CLI uses. Nothing is
+re-implemented here: a `.one` section, a `.onetoc2` notebook and a `.onepkg`
+package are parsed by the crate in the parent directory.
+
+## Install
+
+Requires Rust (stable) only when building.
+
+```bash
+# development: build and install into the active virtualenv
+python -m venv .venv && . .venv/bin/activate
+pip install maturin
+maturin develop --release   # or: maturin build --release + pip install target/wheels/*.whl
+
+# a wheel for distribution (abi3: one wheel for CPython ≥ 3.8)
+maturin build --release      # → target/wheels/onenote-<ver>-cp38-abi3-<platform>.whl
+pip install target/wheels/onenote-*.whl
+```
+
+## API
+
+```python
+import onenote
+
+section = onenote.read_section("Section.one")        # path or bytes
+section.page_count                                   # int
+page = section.pages[0]
+page.title, page.level, page.created, page.modified  # ISO-8601 UTC strings
+page.authors                                         # list[str]
+page.images                                          # list[Image]
+
+section.markdown(front_matter=True)                  # str, pictures as bare names
+section.images()                                     # list[Image] with .filename/.data
+
+stats = section.write("out/Section.md", "out/img", front_matter=True)
+stats.pages, stats.assets, stats.failures
+```
+
+`Image.data` is `bytes`. Names are unique and deduplicated per section **and are
+the same names `markdown()` links to**, so the in-memory flow is safe:
+
+```python
+md = section.markdown()
+for image in section.images():
+    Path(image.filename).write_bytes(image.data)   # every delivered `![](name)` resolves
+```
+
+`Page.images` uses the same names, filtered to the pictures that page references.
+Links are percent-encoded; `Image.filename` is the raw name.
+
+Some links have no payload in the file — OneNote web clippings and external
+caches reference a picture without embedding it. Those are listed by
+`section.missing_images()` (raw names), so callers can tell "delivered" from
+"referenced only": `links ⊆ {i.filename for i in section.images()} ∪ set(section.missing_images())`.
+
+```python
+notebook = onenote.read_notebook("Open Notebook.onetoc2")
+notebook.name, notebook.toc
+notebook.sections          # [NotebookSection(name, path)]
+notebook.groups            # [Notebook] for section groups
+notebook.errors            # entries whose file/folder is missing
+notebook.all_sections()    # every section, depth first
+
+stats = notebook.write("out/notebook", front_matter=True)
+# out/notebook/<Section>.md + <Section>_assets/, one index.md per level
+```
+
+The tree reflects what conversion does: a folder with its own `.onetoc2` is a
+group even when the parent index does not list it, and `.onetoc2` dotfiles (the
+OneNote Recycle Bin sentinel) are ignored.
+
+```python
+package = onenote.read_package("Open Notebook.onepkg")
+package.entries            # file names inside the cabinet
+package.sections()         # parse every .one entry
+package.extract_to("dir")  # write the entries and return their paths
+stats = package.write("out/package", front_matter=True)
+```
+
+`Package.write` follows the CLI: when the cabinet carries a table of contents it
+converts a notebook tree, otherwise each section on its own. MSZIP and stored
+(no compression) folders are supported; Quantum/LZX raise `ValueError`.
+
+## Errors
+
+Malformed files raise `ValueError` with the parser's message; unreadable paths
+raise `OSError`. `write` never raises for a missing picture link — it reports the
+paths in `stats.failures` and still writes the Markdown.
+
+## Tests
+
+```bash
+pip install -r requirements-dev.txt   # maturin, pytest, twine
+python -m pytest tests -q
+```
+
+The fixtures come from `../tests/fixtures` plus `tests/data/notebook`, a small
+notebook tree (a table of contents, a group and a nested group). The package
+tests build their cabinet in Python, independently of the Rust reader.
+
+## Limitations
+
+Same as the CLI: `[MS-ONESTORE]` revision stores are fully read, `[MS-FSSHTTPB]`
+package stores are marked experimental, encrypted sections are reported but not
+decrypted, and cabinet folders compressed with Quantum or LZX are rejected.
+