chore: update build scripts for python3

README.md

@@ -69,6 +69,22 @@ assert input_exp.evaluate(ctx) == output_exp.evaluate(ctx)
 <!-- ### Visualize a Tree -- needs mathy plugin in docs.sh -->
 <!-- ### Generate Problems -- needs example snippet -->
 
+## Development
+
+Install the prerequisites in a virtual environment (python3 required)
+
+```bash
+sh tools/setup.sh
+```
+
+Run the test suite and view code-coverage statistics
+
+```bash
+sh tools/test.sh
+```
+
+The tests cover ~90% of the code so they're a good reference for how to use the various APIs.
+
 ## Semantic Versioning
 
 Before Mathy Core reaches v1.0 the project is not guaranteed to have a consistent API, which means that types and classes may move around or be removed. That said, we try to be predictable when it comes to breaking changes, so the project uses semantic versioning to help users avoid breakage.

tools/build.sh

@@ -3,4 +3,4 @@ set -e
 . .env/bin/activate
 
 echo "Build python package..."
-python setup.py sdist bdist_wheel
+python3 setup.py sdist bdist_wheel

tools/codecov.sh

@@ -2,4 +2,4 @@
 set -e
 . .env/bin/activate
 pip install codecov
-python -m codecov
+python3 -m codecov

tools/deploy.sh

@@ -10,7 +10,7 @@ echo "--- Install requirements"
 pip install twine wheel
 pip install -r requirements.txt
 echo "--- Buid dists"
-python setup.py sdist bdist_wheel
+python3 setup.py sdist bdist_wheel
 echo "--- Upload to PyPi"
 # NOTE: ignore errors on upload because our CI is dumb and tries to upload
 #       even if the version has already been uploaded. This isn't great, but

tools/docs.sh

@@ -2,5 +2,5 @@
 set -e
 . .env/bin/activate
 mathy_pydoc mathy_core.tokenizer.Tokenizer++ mathy_core.parser++ mathy_core.tree++ mathy_core.expressions++ mathy_core.rules.associative_swap++ mathy_core.rules.balanced_move++ mathy_core.rules.commutative_swap++ mathy_core.rules.constants_simplify++ mathy_core.rules.distributive_factor_out++ mathy_core.rules.distributive_multiply_across++ mathy_core.rules.variable_multiply++ mathy_core.layout++ mathy_core.problems++ > /tmp/pathy_api.md
-python tools/docs.py /tmp/pathy_api.md README.md
+python3 tools/docs.py /tmp/pathy_api.md README.md
 npx prettier README.md --write

tools/setup.sh

@@ -5,7 +5,7 @@ set -e
 DIR=.env
 if [ ! -d "${DIR}" ]; then
   pip install virtualenv --upgrade
-  python -m virtualenv .env -p python3
+  python3 -m virtualenv .env -p python3
 fi
 
 . .env/bin/activate