My Checker¶

Quick math checker

Features¶

Simple expression evaluation.

Contents:¶

Installation¶

At the command line either via easy_install or pip:

$ easy_install my_checker
$ pip install my_checker

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv my_checker
$ pip install my_checker

Usage¶

To use My Checker in a project:

>>> import my_checker
>>> if my_checker.check_math(6 * 9 - 12, 42):
...     print("The answer!")
... else:
...     print("Sorry for the inconvenience.")
The answer!

Contributing¶

Contributions are welcome, but this is a tiny package that I’m using for testing, so it won’t be very useful to anyone but me.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/mareuter/my_checker/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

My Checker could always use more documentation, whether as part of the official My Checker docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/mareuter/my_checker/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up my_checker for local development.

Fork the my_checker repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/my_checker.git

Create a branch for local development:

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

When you’re done making changes, check that your changes pass style and unit tests, including testing other Python versions with tox:
```
$ tox
```

To get tox, just pip install it.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.7, and 3.5, and for PyPy. Check https://travis-ci.org/mareuter/my_checker under pull requests for active pull requests or run the tox command and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ py.test test/test_my_checker.py

Credits¶

Development Lead¶

Michael Reuter <mareuternh@gmail.com>

Contributors¶

None yet. Why not be the first?

History¶

0.1.1 (2016-05-25)¶

Added doctest as usage example.

0.1.0 (2016-05-23)¶

First release on PyPI.

my_checker¶

my_checker package¶

Submodules¶

my_checker.my_checker module¶

my_checker.my_checker.check_math(expression, answer)[source]¶

Check a math expression with an answer.

Parameters:	expression (math equation) – The math expression to check. answer (numeric) – The answer to the expression.
Returns:	True if answer matches evaluated equation, False if not.
Return type:	bool

Module contents¶

Feedback¶

If you have any suggestions or questions about My Checker feel free to email me at mareuternh@gmail.com.

If you encounter any errors or problems with My Checker, please let me know! Open an Issue at the GitHub http://github.com/mareuter/my_checker main repository.