MathKeyboardEngine provides the logic for a highly customizable virtual math keyboard. It is intended for use together with any LaTeX typesetting library.
Project description
MathKeyboardEngine for Python
MathKeyboardEngine for Python provides the logic for a highly customizable virtual math keyboard. It is intended for use together with any LaTeX typesetting library (for example ...).
Also available:
An execution timeline
todo
Let me test it now!
Live examples can be tested at MathKeyboardEngine.GitHub.io.
Pros and cons?
Unique about MathKeyboardEngine:
-
it supports (almost?) all math mode LaTeX, including matrices. (Please share if you know anything that is not supported.)
-
its syntax tree consists of very few different parts: the
StandardLeafNode
,StandardBranchingNode
,AscendingBranchingNode
andDescendingBranchingNode
can be used for almost all LaTeX, including fractions, powers, combinations, subscript, etc. with ready-to-use up/down/left/right navigation. -
it can be used with any LaTeX math typesetting library you like.
A con:
- this library will never be able to handle setting the cursor with the touch of a finger on a typeset formula. (But it DOES support up/down/left/right navigation and has a selection mode via arrow keys.)
More pros:
-
you have full control over what you display on the virtual keyboard keys and what a virtual key press actually does.
-
customize the editor output at runtime: dot or comma as decimal separator, cross or dot for multiplication, cursor style, colors, etc.
-
this library also supports handling input from a physical keyboard, where - for example - the forward slash "/" key can be programmed to result in encapsulating a previously typed number as the numerator of a fraction. (See the examples.)
-
almost forgotten: it's open source, free to use, free to modify (please fork this repo)!
How to use this library
PyPi link: https://pypi.org/project/mathkeyboardengine
Documentation
todo
How to use this repo
Follow these steps to set up (and verify) a development environment for this repository:
-
Install the latest version of Python via https://www.python.org/downloads. The download includes
pip
. -
Open the Terminal in VS Code and run
py -m pip install -U pytest
. -
Run all tests via
py -m pytest
. -
See code coverage:
py -m pip install pytest-cov
+py -m pytest --cov=src --cov-report term-missing
.
Ask or contribute
-
ask questions about anything that is not clear or when you'd like help.
-
share ideas or what you've made.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mathkeyboardengine-0.1.0a5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f2797f68061752492728b72bc4497c9e52a20d896f288bd9aca28ed329180c8 |
|
MD5 | bc6a32de78671a1af5d3d9aca85e0838 |
|
BLAKE2b-256 | ffcc2170d1de3b828aad262a93430b0fcbc33c1da4b736fc915ddd286bcf25a5 |
Hashes for mathkeyboardengine-0.1.0a5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29ec31c6f94f7516342f974bf159acb0b0512a649e34b27ae8dfca8477dd8ad6 |
|
MD5 | 5ddf5dc1dcb546ba7005b9c6e6d27bc5 |
|
BLAKE2b-256 | 800fb8dc632686c491348dd0843ba1e539636d0463876810fb55a891578bc850 |