MathKeyboardEngine.Python/_disthelper/release_steps.txt at main · MathKeyboardEngine/MathKeyboardEngine.Python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
== Release steps ==

> install
py -m pip install --upgrade isort
py -m pip install --upgrade blue
py -m pip install --upgrade wheel
py -m pip install --upgrade twine
py -m pip install --upgrade nox

> save and close all open documents except this one.

> fix namespace import order and code style formatting:
py -m isort . --skip '__init__.py' --skip '.nox' --line-length 999
py -m blue . --line-length 400

> verify that the test coverage is 100%, that the tests of the flatpacked version of mathkeyboardengine pass all versions of Python:
py -m nox

> in setup.py, increment the version="1.0.0-beta.?", then run:
py setup.py sdist bdist_wheel


> login and create an API token on https://pypi.org/manage/account/token/.
> In the upload step, see next, use Edit > Paste (and NOT Ctrl + V) in VS Code on Windows.

> upload to PyPi:
py -m twine check dist/*
py -m twine upload dist/*

> create a git tag of the format 'v1.0.0' / 'v1.0.0-beta.2' via VS Code's history tab and push it:
git push origin --tags


== Manually testing the release ==
> create a folder 'Test' and open it in VS Code, then run:
py -m pip install mathkeyboardengine==1.0.0b (Change the version number to the latest version. Running this command twice seems necessary sometimes.)

> create a new file `main.py` with the following content:
```
from mathkeyboardengine import LatexConfiguration, Placeholder, TreeNode, KeyboardMemory, get_edit_mode_latex, get_view_mode_latex, LeafNode, BranchingNode, StandardLeafNode, PartOfNumberWithDigits, DecimalSeparatorNode, DigitNode, StandardBranchingNode, AscendingBranchingNode, DescendingBranchingNode, RoundBracketsNode, MatrixNode, move_right, move_down, move_left, move_up, insert, insert_with_encapsulate_current, leave_selection_mode, insert_with_encapsulate_selection, insert_with_encapsulate_selection_and_previous, delete_left, delete_right, delete_selection, select_left, select_right, in_selection_mode, enter_selection_mode, parse_latex, LatexParserConfiguration

k = KeyboardMemory()
latexconfiguration = LatexConfiguration()
print(get_edit_mode_latex(k, latexconfiguration))
```
> In the upper-right corner of VS Code, click the play button and verify that the Terminal displays `\blacksquare`. If success, all imports are available as they should.