Making a Mathics Release

This information is for Project administrators. It is likely to be of little interest for most.

To perform these steps, this you’ll need a project administrator accounts and access on github, PyPI and dockerhub.


Let folks know in advance about the release. During the release of course, ensure no one is changing master (except the person doing the release).

Get latest sources:

$ git pull

Change version in mathics/

On mathics/Mathics master branch. For each release candidate:

update __version__ in mathics/

$ source mathics/ # to set in POSIX shell
$ echo $__version__
$ git commit -m"Get ready for release $__version__" .

Update Changes

$ make ChangeLog

Update CHANGES.rst from ChangeLog

$ make check
$ git commit --amend .
$ git push   # get CI testing going early can be used for checking the RsT.

Build Docs

$ make doc

See also [[Documentation and tests]].

Check package from github

TODO: turn this into a script in admin-tools

$ [[ ! -d /tmp/gittest ]] && mkdir /tmp/gittest; pushd /tmp/gittest
$ pyenv local 3.7.7  # Use a version that is not the most recent
$ pip install -e git://
$ mathics --version # see that new version appears
$ mathics -e "1+2"
$ pip uninstall mathics3
$ popd

Make packages and check

$ ./admin-tools/
$ twine check dist/Mathics3-$__version__*

Release on Github

Go to can be used to change the CHANGES.rst section to markdown.

Now check the tagged release. (Checking the untagged release was previously done).

TODO: turn this into a script in admin-tools

$ git pull # to pull down new tag
$ pushd /tmp/gittest
$ pip install -e git://${__version__}#egg=mathics
$ mathics --version
$ mathics -e "1+2"
$ pip uninstall mathics3
$ popd

Upload the release to PyPI

Upload it to PyPI with twine

$ twine upload dist/Mathics3-${__version__}*


Update mathicsscript

Update docker setup

$ make docker-image
$ docker run --rm -it --name mathics-cli -v /tmp:/usr/src/app/data mathicsorg/mathics --mode cli -- --version
$ docker run --rm -it --name mathics-cli -v /tmp:/usr/src/app/data mathicsorg/mathics --mode cli -- -e 1+2
$ docker tag mathicsorg/mathics:latest  mathicsorg/mathics:${__version__}


Update PDF

$ cp mathics/doc/tex/mathics.pdf ../${__version__}.pdf
$ cd ../
$ git add mathics-${__version__}.pdf
$ rm mathics-latest.pdf
$ ln -vs mathics-${__version__}.pdf mathics-latest.pdf
$ git commit .
$ git push