Skip to main content

Mathmaker creates automatically elementary maths exercises and their (detailed) answers.

Project description

PyPI1 PyPI2 PyPI3 Build Status Coveralls Documentation Status Maintenance PyPI4

Overview

Mathmaker creates elementary maths worksheets with detailed solutions.

The output documents can be compiled into pdf files by lualatex. Examples of available themes are: first degree equations, pythagorean theorem, fractions calculation…

It can run from command line, but can be controlled via http requests too.

Licence Documentation (master release) Documentation (latest development version)).

Quickstart

Complete install

  • on Ubuntu 14.04 or later:

    External dependencies:

    $ sudo apt-get install eukleides libxml2-utils gettext texlive-full

    Note: to avoid installing texlive-full, check the documentation.

    Then:

    $ pip3 install mathmaker
  • on FreeBSD 10.*:

    External dependencies:

    $ sudo pkg install python36 py36-sqlite3 gettext eukleides libxml2 texlive-full
    $ rehash
    
    **note**
    
    Because of a bug in current FreeBSD's eukleides package you'll
    have to fix eukleides install. See
    `here <http://mathmaker.readthedocs.io/en/master/user_doc.html#eukleides-fix>`__.

    Once you’re done, you can proceed installing mathmaker:

    $ pip3 install mathmaker
    
    **note**
    
    If you stumble upon an error during the install of the
    python-daemon dependency, you'll find the way to solve it
    `there <http://mathmaker.readthedocs.io/en/master/user_doc.html#python-daemon-error-at-install>`__

Basic use

$ mathmaker pythagorean-theorem-short-test > out.tex
$ lualatex out.tex

or directly:

$ mathmaker pythagorean-theorem-short-test --pdf > out.pdf

Get the list of all provided sheets(3):

$ mathmaker list

To get the command-line options, you can use mathmaker --help.

Several settings can be overriden by user defined values in ~/.config/mathmaker/user_config.yaml. Read the complete documentation for more information.

Advanced use

It’s possible to create your own sheets in yaml. Read from the complete documentation for more information.

Contribute

You can contribute to mathmaker:

As a wordings contributor

Mathmaker needs contexts for problems wordings. There are already some, but the more there is, the better. Existing wordings can be found here. You can submit any new idea as an enhancement proposal there (should be written in english, french or german).

Any question can be sent to nh dot techn (hosted at gmail dot com).

As a translator

You can help translating mathmaker to your language (or any language you like, if you have enough elementary maths vocabulary for that).

If the translation to your language isn’t started yet, there are several pot files to get here (see explanations about their respective roles there). You can use an editor like poedit or any other you like better, to create po files from them and start to translate.

If you want to add missing translations, or to correct some, you can find the po files in the subdirectories here.

Once you’re done, you can make a pull request here.

Any question can be sent to nh dot techn (hosted at gmail dot com).

As a developer

Before submitting a PR, please ensure you’ve had a look at the writing rules.

More details can be found in the documentation for developers.

Any question can be sent to nh dot techn (hosted at gmail dot com).

Additional informations

Contact: nh dot techn (hosted by gmail dot com)

Changelog

Contributors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

mathmaker-0.7.21-py3-none-any.whl (7.5 MB view details)

Uploaded Python 3

File details

Details for the file mathmaker-0.7.21-py3-none-any.whl.

File metadata

  • Download URL: mathmaker-0.7.21-py3-none-any.whl
  • Upload date:
  • Size: 7.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for mathmaker-0.7.21-py3-none-any.whl
Algorithm Hash digest
SHA256 b6900df54d83e62e17947527fb8c29ffd991ed9834999ed40ab65e80d6bcec6a
MD5 a7da26ed7180b78f32df0202e637ad33
BLAKE2b-256 1af60bfa0ac5afcb360448f818b955c45b04f62b40612a2b46ea58839d878df2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page