docs: add Python library documentation - #376
Merged
Merged
Conversation
angpt
commented
Apr 3, 2026
angpt
commented
Contributor
- Added "Building with Python" guide (docs/python/building-with-python.md) covering installation, three build approaches (EncoderfileBuilder, build(), build_from_config()), tokenizer configuration, Lua transforms, cross-compilation, and inspecting binaries
- Added manually curated Python API reference (docs/python/api-reference.md) with argument tables, types, defaults, and examples for every public class and function
- Added "Python Library" section to mkdocs.yml nav and docs/index.md
- Added README.md Option 3 (Python Package) to include uv add encoderfile, fix double-colon typo, and link to the new docs pages
- Added "Building with Python" guide (docs/python/building-with-python.md) covering installation, three build approaches (EncoderfileBuilder, build(), build_from_config()), tokenizer configuration, Lua transforms, cross-compilation, and inspecting binaries - Added manually curated Python API reference (docs/python/api-reference.md) with argument tables, types, defaults, and examples for every public class and function - Added "Python Library" section to mkdocs.yml nav and docs/index.md - Added README.md Option 3 (Python Package) to include uv add encoderfile, fix double-colon typo, and link to the new docs pages
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
javiermtorres
approved these changes
Apr 6, 2026
javiermtorres
left a comment
javiermtorres
left a comment
Contributor
There was a problem hiding this comment.
LGTM, just a couple of comments
| |---|---|---|---| | ||
| | `workdir` | `str \| None` | system temp | Temporary working directory for intermediate build files. | | ||
| | `version` | `str \| None` | `None` | Override the encoderfile runtime version to embed. Takes precedence over the version set on the builder. | | ||
| | `no_download` | `bool` | `False` | Disable downloading the base binary. Requires `base_binary_path` or a cached binary. | |
Contributor
There was a problem hiding this comment.
Let's check in a separate PR what would be the error when no_download is specified but the binary is not found.
Co-authored-by: javiermtorres <javier@mozilla.ai>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.