mathplug 0.0.1

A lightweight Python package which supplies simple math functions.

 __   __  _______  _______  __   __  _______  ___      __   __  _______ 
|  |_|  ||   _   ||       ||  | |  ||       ||   |    |  | |  ||       |
|       ||  |_|  ||_     _||  |_|  ||    _  ||   |    |  | |  ||    ___|
|       ||       |  |   |  |       ||   |_| ||   |    |  |_|  ||   | __ 
|       ||       |  |   |  |       ||    ___||   |___ |       ||   ||  |
| ||_|| ||   _   |  |   |  |   _   ||   |    |       ||       ||   |_| |
|_|   |_||__| |__|  |___|  |__| |__||___|    |_______||_______||_______|

Overview

mathplug is a lightweight Python package which supplies simple math functions. It was primarily designed as an excuse to learn how to publish a Python package. Secondarily, this will give me an opportunity to learn some of the more complicated mathematical equations since I somehow skipped that part. In the future, you'll be able to install and import this software into your notebook or Python file and use it to add some numbers together. How exciting!

Install & use

1. From terminal: shell pip install mathplug
2. From python environment: import mathplug

Test

1. Clone repository: git clone https://github.com/JordanWelsman/mathplug.git
2. Build module: <python | python3> setup.py bdist_wheel
3. Install module locally: pip install -e . dev
4. Run tests with PyTest: pytest

Table of contents

• Overview
  • Install & use
  • Test
• Table of contents
• Objectives
• History
  • 0.0.1
• Credits
• License

Objectives

• Learn how to publish a Python package
• Learn some more complicated math functions

History

0.0.1

• Simple math functions defined
• Package files created
• Created test files & tested with pytest
• Package published to PyPI

Credits

mathplug was created, developed, and is currently maintained by Jordan Welsman.

License

mathplug is developed and distributed under the MIT license.

See LICENSE.md for more details.