Mathematical Expression Evaluator (math-evaluate)

By mhaxanali

PyPI project link

https://pypi.org/project/math-evaluate

About the project

A simple command-line calculator for quick math without leaving the terminal.

Installation

Install using:

pip install math-evaluate

Usage

Example usage:

math "10*(5-2)^2 / 3"

Output: 30

Using the Evaluator for your own Projects

In order to use the mathematical expression evaluator in your own projects, follow these steps:

• Set up a virtual environment in your project folder (Optional):

  python -m venv venv
  source venv/bin/activate # for macOS/Linux
  venv\Scripts\activate.bat # for windows CMD
  .\venv\Scripts\Activate.ps1 # for windows Powershell
  

• Install math-evaluate using pip:

  pip install math-evaluate
  

• Now, in your code add this line:

  from math_evaluate.evaluator import evaluate
  

• Now, you can call the evaluator function to return a string which can be an error message or result while giving it the mathematical expression as argument:

  result = evaluate("5+5")
  print(result, type(result))
  

  Output: 10 <class 'str'>

Testing

• Unittests have been included in ./tests.py
• Running tests:
  1. Clone the repository:

     git clone https://github.com/mhaxanali/math-evaluate
     

  2. Navigate to the repository:

     cd math-evaluate
     

  3. Run the tests:

     python tests.py
     

Notes

• Supported operators: +, -, *, /, (, ), ^
• This evaluator follows BODMAS/PEMDAS.
• Division and multiplication are evaluated left to right, same for addition and subtraction.
• Exponent associativity is supported.
• Use brackets () if you want to force evaluation order.
• Requires Python 3.10 or later.
• Argument Parsing might glitch when using zsh if you try to evaluate an expression which contains -(.
  • If this happens then run the script using:

    math --eval="<expression>"
    

• The CLI command is installed as math.