# mathy_envs: Learning environments for solving math problems
![Build](https://github.com/mathy/mathy_envs/workflows/Build/badge.svg)
![Types](https://github.com/mathy/mathy_envs/workflows/Types/badge.svg)
[![codecov](https://codecov.io/gh/mathy/mathy_envs/branch/master/graph/badge.svg)](https://codecov.io/gh/mathy/mathy_envs)
[![Pypi version](https://badgen.net/pypi/v/mathy-envs)](https://pypi.org/project/mathy-envs/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
Mathy environments present users/agents with a prompt problem, and are asked to simplify it according to some problem-specific criteria using combinations of simple actions based on the Properties of Numbers.
## 🚀 Quickstart
You can install `mathy_envs` from pip:
```bash
pip install mathy_envs
```
## Semantic Versioning
Mathy Envs tries to be predictable when it comes to breaking changes, so the project uses semantic versioning to help users avoid breakage.
Specifically, new releases increase the `patch` semver component for new features and fixes, and the `minor` component when there are breaking changes. If you don't know much about semver strings, they're usually formatted `{major}.{minor}.{patch}` so increasing the `patch` component means incrementing the last number.
Consider a few examples:
| From Version | To Version | Changes are Breaking |
| :----------: | :--------: | :------------------: |
| 0.2.0 | 0.2.1 | No |
| 0.3.2 | 0.3.6 | No |
| 0.3.1 | 0.3.17 | No |
| 0.2.2 | 0.3.0 | Yes |
If you are concerned about breaking changes, you can pin the version in your requirements so that it does not go beyond the current semver `minor` component, for example if the current version was `0.1.37`:
```
mathy_envs>=0.1.37,<0.2.0
```
## Contributors
Mathy Envs wouldn't be possible without the wonderful contributions of the following people:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a target="_blank" href="https://www.justindujardin.com/"><img src="https://avatars0.githubusercontent.com/u/101493?v=4" width="100px;" alt=""/><br /><sub><b>Justin DuJardin</b></sub></a></td>
<td align="center"><a target="_blank" href="https://twitter.com/Miau_DB"><img src="https://avatars3.githubusercontent.com/u/7149899?v=4" width="100px;" alt=""/><br /><sub><b>Guillem Duran Ballester</b></sub></a></td>
</tr>
</table>
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Raw data
{
"_id": null,
"home_page": "https://mathy.ai",
"name": "mathy-envs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "math",
"author": "Justin DuJardin",
"author_email": "justin@dujardinconsulting.com",
"download_url": "https://files.pythonhosted.org/packages/a3/1e/f8d8c35fae9db7edd8b9dbba9c81a4deabdda14a9571f9d113453de75b41/mathy_envs-0.12.0.tar.gz",
"platform": null,
"description": "# mathy_envs: Learning environments for solving math problems\n\n![Build](https://github.com/mathy/mathy_envs/workflows/Build/badge.svg)\n![Types](https://github.com/mathy/mathy_envs/workflows/Types/badge.svg)\n[![codecov](https://codecov.io/gh/mathy/mathy_envs/branch/master/graph/badge.svg)](https://codecov.io/gh/mathy/mathy_envs)\n[![Pypi version](https://badgen.net/pypi/v/mathy-envs)](https://pypi.org/project/mathy-envs/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\nMathy environments present users/agents with a prompt problem, and are asked to simplify it according to some problem-specific criteria using combinations of simple actions based on the Properties of Numbers.\n\n## \ud83d\ude80 Quickstart\n\nYou can install `mathy_envs` from pip:\n\n```bash\npip install mathy_envs\n```\n\n\n## Semantic Versioning\n\nMathy Envs tries to be predictable when it comes to breaking changes, so the project uses semantic versioning to help users avoid breakage.\n\nSpecifically, new releases increase the `patch` semver component for new features and fixes, and the `minor` component when there are breaking changes. If you don't know much about semver strings, they're usually formatted `{major}.{minor}.{patch}` so increasing the `patch` component means incrementing the last number.\n\nConsider a few examples:\n\n| From Version | To Version | Changes are Breaking |\n| :----------: | :--------: | :------------------: |\n| 0.2.0 | 0.2.1 | No |\n| 0.3.2 | 0.3.6 | No |\n| 0.3.1 | 0.3.17 | No |\n| 0.2.2 | 0.3.0 | Yes |\n\nIf you are concerned about breaking changes, you can pin the version in your requirements so that it does not go beyond the current semver `minor` component, for example if the current version was `0.1.37`:\n\n```\nmathy_envs>=0.1.37,<0.2.0\n```\n\n## Contributors\n\nMathy Envs wouldn't be possible without the wonderful contributions of the following people:\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tr>\n <td align=\"center\"><a target=\"_blank\" href=\"https://www.justindujardin.com/\"><img src=\"https://avatars0.githubusercontent.com/u/101493?v=4\" width=\"100px;\" alt=\"\"/><br /><sub><b>Justin DuJardin</b></sub></a></td>\n <td align=\"center\"><a target=\"_blank\" href=\"https://twitter.com/Miau_DB\"><img src=\"https://avatars3.githubusercontent.com/u/7149899?v=4\" width=\"100px;\" alt=\"\"/><br /><sub><b>Guillem Duran Ballester</b></sub></a></td>\n </tr>\n</table>\n\n<!-- markdownlint-enable -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n",
"bugtrack_url": null,
"license": "All rights reserved",
"summary": "Learning environments for solving math problems step-by-step",
"version": "0.12.0",
"project_urls": {
"Homepage": "https://mathy.ai"
},
"split_keywords": [
"math"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f1784b460652829795240817cf144f1b3c81b90eb566b7c0377a2e5e3d358190",
"md5": "ec3de8d5686431e30132338682124a7d",
"sha256": "3f6f5891df1d6f7e7785136136001e252356e5543c789e7ccc34f48a1ad07352"
},
"downloads": -1,
"filename": "mathy_envs-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec3de8d5686431e30132338682124a7d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 39970,
"upload_time": "2023-11-29T21:56:18",
"upload_time_iso_8601": "2023-11-29T21:56:18.118781Z",
"url": "https://files.pythonhosted.org/packages/f1/78/4b460652829795240817cf144f1b3c81b90eb566b7c0377a2e5e3d358190/mathy_envs-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a31ef8d8c35fae9db7edd8b9dbba9c81a4deabdda14a9571f9d113453de75b41",
"md5": "3ed486ca3ad9fba67e22928c327f7434",
"sha256": "f838a40d2bae8130c0756bde432591ba8564e6cdf27b61df4512fa0598ef2fc1"
},
"downloads": -1,
"filename": "mathy_envs-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "3ed486ca3ad9fba67e22928c327f7434",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 30069,
"upload_time": "2023-11-29T21:56:19",
"upload_time_iso_8601": "2023-11-29T21:56:19.798321Z",
"url": "https://files.pythonhosted.org/packages/a3/1e/f8d8c35fae9db7edd8b9dbba9c81a4deabdda14a9571f9d113453de75b41/mathy_envs-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 21:56:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mathy-envs"
}