Skip to main content

Python tools for math education workflows.

Project description

edu-math

CI Python Versions Package Version License

edu-math is a Python package for math education workflows.

The PyPI distribution is osl-edu-math; the import package remains edumath.

The project is in its initial scaffold stage. The repository includes packaging, testing, linting, documentation, release automation, and GitHub workflow infrastructure adapted from the Open Science Labs Incubator Python package template used by prisma-flow.

Installation

pip install osl-edu-math

Symbolic equation solving

edumath.solvers provides SymPy-backed equation solving with structured solution steps. The math is computed locally and can be used without any API key:

from edumath.core import parse_equation
from edumath.solvers import solve_equation_steps

equation = parse_equation("2(x - 3) + 4 = 10")
solution = solve_equation_steps(equation)
print(solution.answer)
print(solution.render_text())

Optional AI tutor explanations can be enabled through edumath.settings. The AI text is added after SymPy/edumath has solved and checked the equation, so the symbolic result remains the source of truth:

from edumath.core import parse_equation
from edumath.settings import configure
from edumath.solvers import solve_equation_steps

configure(openai_api_key="YOUR_OPENAI_API_KEY")
equation = parse_equation("2(x - 3) + 4 = 10")
solution = solve_equation_steps(equation, explain=True)
print(solution.explanation)

Development

conda env create -f conda/dev.yaml
conda activate edumath
poetry config virtualenvs.create false
poetry install --extras "dev"

Run checks through Makim:

makim tests.linter
makim tests.unit
makim package.build
makim docs.build

Project layout

  • src/edumath/: Python package source
  • tests/: pytest test suite
  • docs/: Quarto documentation website
  • conda/: development and release environment files
  • .github/: issue templates and GitHub Actions workflows

Project details


Download files

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

Source Distribution

osl_edu_math-0.4.3.tar.gz (82.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

osl_edu_math-0.4.3-py3-none-any.whl (125.5 kB view details)

Uploaded Python 3

File details

Details for the file osl_edu_math-0.4.3.tar.gz.

File metadata

  • Download URL: osl_edu_math-0.4.3.tar.gz
  • Upload date:
  • Size: 82.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.14 Linux/6.17.0-1018-azure

File hashes

Hashes for osl_edu_math-0.4.3.tar.gz
Algorithm Hash digest
SHA256 1892328aa150857a6fba4fc7f505c0156cdb61d209013d979615f7286cb7d413
MD5 88721eacaf5edbccc640832c2bf15349
BLAKE2b-256 03b3903dd5ad40a0af284b86d67091833006800edf53a9d63a36ffbdfb403c93

See more details on using hashes here.

File details

Details for the file osl_edu_math-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: osl_edu_math-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 125.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.14 Linux/6.17.0-1018-azure

File hashes

Hashes for osl_edu_math-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b8cb48a7a88e10bc93346633ca8dbdfd24f42794ca54166ac808a19ffc5bf1a1
MD5 836f67d0b1dcab5583fa6b5b1e521511
BLAKE2b-256 b741246f65e7ccfdd37216475829b5dde3a346cb725b630ccdb67431afa73366

See more details on using hashes here.

Supported by

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