| Name | mathmaker JSON |
| Version |
0.7.24
JSON |
| download |
| home_page | None |
| Summary | Mathmaker creates automatically elementary maths exercises and their (detailed) answers. |
| upload_time | 2024-12-21 06:58:53 |
| maintainer | None |
| docs_url | None |
| author | Nicolas Hainaux |
| requires_python | <4.0,>=3.9 |
| license | GPL-3.0-or-later |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
|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 <https://gitlab.com/nicolas.hainaux/mathmaker/blob/master/LICENSE>`__
`Documentation (master
release) <http://mathmaker.readthedocs.io/en/master/index.html>`__
`Documentation (latest development
version)) <http://mathmaker.readthedocs.io/en/dev/index.html>`__.
Quickstart
==========
Complete install
----------------
.. note::
python3.6+ is mandatory for mathmaker to work, so check is installed on your system
- 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 <http://mathmaker.readthedocs.io/en/master/user_doc.html#install>`__.
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 <http://mathmaker.readthedocs.io/en/master/user_doc.html#user-settings>`__
for more information.
Advanced use
------------
It's possible to create your own sheets in yaml. Read from `the complete
documentation <http://mathmaker.readthedocs.io/en/master/user_doc.html#yaml-sheets>`__
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 <https://gitlab.com/nicolas.hainaux/mathmaker/tree/dev/mathmaker/data/wordings>`__.
You can submit any new idea as an enhancement proposal
`there <https://gitlab.com/nicolas.hainaux/mathmaker/issues>`__ (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 <https://gitlab.com/nicolas.hainaux/mathmaker/tree/dev/mathmaker/locale>`__
(see explanations about their respective roles
`there <http://mathmaker.readthedocs.io/en/dev/dev_doc.html#the-real-and-the-fake-translation-files>`__).
You can use an editor like `poedit <https://poedit.net/>`__ 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 <https://gitlab.com/nicolas.hainaux/mathmaker/tree/dev/mathmaker/locale>`__.
Once you're done, you can make a pull request
`here <https://gitlab.com/nicolas.hainaux/mathmaker/pulls>`__.
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 <http://mathmaker.readthedocs.io/en/dev/dev_doc.html#writing-rules>`__.
More details can be found in the `documentation for
developers <http://mathmaker.readthedocs.io/en/dev/dev_index.html>`__.
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 <https://gitlab.com/nicolas.hainaux/mathmaker/blob/master/CHANGELOG.rst>`__
`Contributors <https://gitlab.com/nicolas.hainaux/mathmaker/blob/master/CONTRIBUTORS.rst>`__
.. |PyPI1| image:: https://img.shields.io/pypi/v/mathmaker.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/mathmaker
.. |PyPI2| image:: https://img.shields.io/pypi/status/mathmaker.svg?maxAge=2592000
.. |PyPI3| image:: https://img.shields.io/pypi/pyversions/mathmaker.svg?maxAge=2592000
.. |Build Status| image:: https://ci.appveyor.com/api/projects/status/88ay13trwvipaijb/branch/master?svg=true
:target: https://ci.appveyor.com/project/nicolashainaux/mathmakerlib-ho94f
.. |Coveralls| image:: https://coveralls.io/repos/gitlab/nicolashainaux/mathmaker/badge.svg?branch=master
:target: https://coveralls.io/gitlab/nicolashainaux/mathmaker?branch=master
.. |Documentation Status| image:: https://readthedocs.org/projects/mathmaker/badge/?version=latest
:target: https://mathmaker.readthedocs.io/en/latest/
.. |Maintenance| image:: https://img.shields.io/maintenance/yes/2021.svg?maxAge=2592000
.. |PyPI4| image:: https://img.shields.io/pypi/l/mathmaker.svg?maxAge=2592000
:target: https://gitlab.com/nicolas.hainaux/mathmaker/blob/master/LICENSE
Raw data
{
"_id": null,
"home_page": null,
"name": "mathmaker",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Nicolas Hainaux",
"author_email": "nh.techn@posteo.net",
"download_url": null,
"platform": null,
"description": "|PyPI1| |PyPI2| |PyPI3| |Build Status| |Coveralls| |Documentation Status| |Maintenance| |PyPI4|\n\nOverview\n========\n\nMathmaker creates elementary maths worksheets with detailed solutions.\n\nThe output documents can be compiled into pdf files by lualatex.\nExamples of available themes are: first degree equations, pythagorean\ntheorem, fractions calculation...\n\nIt can run from command line, but can be controlled via http requests\ntoo.\n\n`Licence <https://gitlab.com/nicolas.hainaux/mathmaker/blob/master/LICENSE>`__\n`Documentation (master\nrelease) <http://mathmaker.readthedocs.io/en/master/index.html>`__\n`Documentation (latest development\nversion)) <http://mathmaker.readthedocs.io/en/dev/index.html>`__.\n\nQuickstart\n==========\n\nComplete install\n----------------\n\n.. note::\n\n python3.6+ is mandatory for mathmaker to work, so check is installed on your system\n\n- on Ubuntu 14.04 or later:\n\n External dependencies:\n\n ::\n\n $ sudo apt-get install eukleides libxml2-utils gettext texlive-full\n\n Note: to avoid installing ``texlive-full``, check the\n `documentation <http://mathmaker.readthedocs.io/en/master/user_doc.html#install>`__.\n\n Then:\n\n ::\n\n $ pip3 install mathmaker\n\n- on FreeBSD 10.\\*:\n\n External dependencies:\n\n ::\n\n $ sudo pkg install python36 py36-sqlite3 gettext eukleides libxml2 texlive-full\n $ rehash\n\n **note**\n\n Because of a bug in current FreeBSD's eukleides package you'll\n have to fix eukleides install. See\n `here <http://mathmaker.readthedocs.io/en/master/user_doc.html#eukleides-fix>`__.\n\n Once you're done, you can proceed installing mathmaker:\n\n ::\n\n $ pip3 install mathmaker\n\n **note**\n\n If you stumble upon an error during the install of the\n python-daemon dependency, you'll find the way to solve it\n `there <http://mathmaker.readthedocs.io/en/master/user_doc.html#python-daemon-error-at-install>`__\n\nBasic use\n---------\n\n::\n\n $ mathmaker pythagorean-theorem-short-test > out.tex\n $ lualatex out.tex\n\nor directly:\n\n::\n\n $ mathmaker pythagorean-theorem-short-test --pdf > out.pdf\n\nGet the list of all provided sheets(3):\n\n::\n\n $ mathmaker list\n\nTo get the command-line options, you can use ``mathmaker --help``.\n\nSeveral settings can be overriden by user defined values in\n``~/.config/mathmaker/user_config.yaml``. Read `the complete\ndocumentation <http://mathmaker.readthedocs.io/en/master/user_doc.html#user-settings>`__\nfor more information.\n\nAdvanced use\n------------\n\nIt's possible to create your own sheets in yaml. Read from `the complete\ndocumentation <http://mathmaker.readthedocs.io/en/master/user_doc.html#yaml-sheets>`__\nfor more information.\n\nContribute\n==========\n\nYou can contribute to mathmaker:\n\nAs a wordings contributor\n-------------------------\n\nMathmaker needs contexts for problems wordings. There are already some,\nbut the more there is, the better. Existing wordings can be found\n`here <https://gitlab.com/nicolas.hainaux/mathmaker/tree/dev/mathmaker/data/wordings>`__.\nYou can submit any new idea as an enhancement proposal\n`there <https://gitlab.com/nicolas.hainaux/mathmaker/issues>`__ (should\nbe written in english, french or german).\n\nAny question can be sent to nh dot techn (hosted at gmail dot com).\n\nAs a translator\n---------------\n\nYou can help translating mathmaker to your language (or any language you\nlike, if you have enough elementary maths vocabulary for that).\n\nIf the translation to your language isn't started yet, there are several\npot files to get\n`here <https://gitlab.com/nicolas.hainaux/mathmaker/tree/dev/mathmaker/locale>`__\n(see explanations about their respective roles\n`there <http://mathmaker.readthedocs.io/en/dev/dev_doc.html#the-real-and-the-fake-translation-files>`__).\nYou can use an editor like `poedit <https://poedit.net/>`__ or any other\nyou like better, to create po files from them and start to translate.\n\nIf you want to add missing translations, or to correct some, you can\nfind the po files in the subdirectories\n`here <https://gitlab.com/nicolas.hainaux/mathmaker/tree/dev/mathmaker/locale>`__.\n\nOnce you're done, you can make a pull request\n`here <https://gitlab.com/nicolas.hainaux/mathmaker/pulls>`__.\n\nAny question can be sent to nh dot techn (hosted at gmail dot com).\n\nAs a developer\n--------------\n\nBefore submitting a PR, please ensure you've had a look at the `writing\nrules <http://mathmaker.readthedocs.io/en/dev/dev_doc.html#writing-rules>`__.\n\nMore details can be found in the `documentation for\ndevelopers <http://mathmaker.readthedocs.io/en/dev/dev_index.html>`__.\n\nAny question can be sent to nh dot techn (hosted at gmail dot com).\n\nAdditional informations\n-----------------------\n\nContact: nh dot techn (hosted by gmail dot com)\n\n`Changelog <https://gitlab.com/nicolas.hainaux/mathmaker/blob/master/CHANGELOG.rst>`__\n\n`Contributors <https://gitlab.com/nicolas.hainaux/mathmaker/blob/master/CONTRIBUTORS.rst>`__\n\n.. |PyPI1| image:: https://img.shields.io/pypi/v/mathmaker.svg?maxAge=2592000\n :target: https://pypi.python.org/pypi/mathmaker\n.. |PyPI2| image:: https://img.shields.io/pypi/status/mathmaker.svg?maxAge=2592000\n.. |PyPI3| image:: https://img.shields.io/pypi/pyversions/mathmaker.svg?maxAge=2592000\n.. |Build Status| image:: https://ci.appveyor.com/api/projects/status/88ay13trwvipaijb/branch/master?svg=true\n :target: https://ci.appveyor.com/project/nicolashainaux/mathmakerlib-ho94f\n.. |Coveralls| image:: https://coveralls.io/repos/gitlab/nicolashainaux/mathmaker/badge.svg?branch=master\n :target: https://coveralls.io/gitlab/nicolashainaux/mathmaker?branch=master\n.. |Documentation Status| image:: https://readthedocs.org/projects/mathmaker/badge/?version=latest\n :target: https://mathmaker.readthedocs.io/en/latest/\n.. |Maintenance| image:: https://img.shields.io/maintenance/yes/2021.svg?maxAge=2592000\n.. |PyPI4| image:: https://img.shields.io/pypi/l/mathmaker.svg?maxAge=2592000\n :target: https://gitlab.com/nicolas.hainaux/mathmaker/blob/master/LICENSE\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Mathmaker creates automatically elementary maths exercises and their (detailed) answers.",
"version": "0.7.24",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "44d6609b721244c6058760f040c814ead60525c7f0e0aa5cc2857fbc59b08af0",
"md5": "0626daa2559a252612dafcc4e8b56de4",
"sha256": "8fa798a27ced8425bb2e989db32bc74ae53d7a18b1f02fa517cb130f9bd17487"
},
"downloads": -1,
"filename": "mathmaker-0.7.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0626daa2559a252612dafcc4e8b56de4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 7474723,
"upload_time": "2024-12-21T06:58:53",
"upload_time_iso_8601": "2024-12-21T06:58:53.056192Z",
"url": "https://files.pythonhosted.org/packages/44/d6/609b721244c6058760f040c814ead60525c7f0e0aa5cc2857fbc59b08af0/mathmaker-0.7.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 06:58:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mathmaker"
}
