https://github.com/lukew3/mathgenerator

A math problem generator, created for the purpose of giving self-studying students and teaching organizations the means to easily get access to high-quality, generated math problems to suit their needs.
https://github.com/lukew3/mathgenerator

contributions-welcome education generator learning math mathematics maths python python3

Last synced: 3 months ago
JSON representation

A math problem generator, created for the purpose of giving self-studying students and teaching organizations the means to easily get access to high-quality, generated math problems to suit their needs.

• Host: GitHub
• URL: https://github.com/lukew3/mathgenerator
• Owner: lukew3
• License: mit
• Created: 2020-08-20T01:05:40.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-14T14:34:30.000Z (8 months ago)
• Last Synced: 2024-10-01T16:38:54.157Z (3 months ago)
• Topics: contributions-welcome, education, generator, learning, math, mathematics, maths, python, python3
• Language: Python
• Homepage: https://lukew3.github.io/mathgenerator
• Size: 8.67 MB
• Stars: 686
• Watchers: 11
• Forks: 175
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mathgenerator

A math problem generator, created for the purpose of giving teachers and students the means to easily get access to random math exercises to suit their needs.

To try out generators, go to 

See [CONTRIBUTING.md](https://github.com/lukew3/mathgenerator/blob/main/CONTRIBUTING.md) for information about how to contribute.

## Table of Contents

* [Installation](#installation)

* [Usage](#usage)

* [Documentation](#documentation)

## Installation

The project can be install via pip

```bash

pip install mathgenerator

```

## Usage

Here is an example of how you would generate an addition problem:

```python

import mathgenerator

#generate an addition problem

problem, solution = mathgenerator.addition()

#another way to generate an addition problem using genById()

problem, solution = mathgenerator.genById(0)

```

You may prefer to use `import mathgenerator as mg` and run functions like `mg.addition()` so that you don't have to type as much.

Problem/solution pairs are generated with either:

* `mathgenerator.()` - generates a problem, solution set from the given generator name.

* `mathgenerator.genById(id)` - generates a problem, solution set with generator id provided by the `id` parameter

You can also use `getGenList()` to return a list of all generators included in the library in the format:

```

[funcname, subjectname]

```

## Documentation

Documentation can be found at https://lukew3.github.io/mathgenerator