__ __ _______ _______ __ __ _______ ___ __ __ _______
| |_| || _ || || | | || || | | | | || |
| || |_| ||_ _|| |_| || _ || | | | | || ___|
| || | | | | || |_| || | | |_| || | __
| || | | | | || ___|| |___ | || || |
| ||_|| || _ | | | | _ || | | || || |_| |
|_| |_||__| |__| |___| |__| |__||___| |_______||_______||_______|
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!
Table of contents
Install & use
- From terminal:
shell pip install mathplug
- From python environment:
import mathplug
Test
- Clone repository:
git clone https://github.com/JordanWelsman/mathplug.git
- Build module for testing:
python3 setup.py bdist_wheel
- Install module locally:
pip install -e . dev
- Run tests with
PyTest
:pytest
Build
- Build module for distribution:
python3 setup.py bdist_wheel sdist
- Push to
PyPI
:pip install twine
twine upload dist/*
Objectives
- Learn how to publish a Python package
- Learn some more complicated math functions
History
0.0.0
(10.21.2022)
- GitHub repositiry created
- Project created
- Basic
README.md
written
- Basic
0.0.1
(10.25.2022)
- Simple math functions defined
-
add()
,divide()
,hello_world()
,multiply
,square_root()
,square()
, andsubtract()
-
- Package files created
-
setup.py
andLICENSE.md
-
- Created test files & tested with
pytest
-
test_add.py
,test_divide.py
,test_hello_world.py
,test_multiply.py
,test_square_root.py
,test_square.py
, andtest_subtract.py
-
- Package published to
PyPI
0.0.2
(10.25.2022)
- Aggregated all functions into one file
- Functions should be optionally imported with
import mathplug
, not strictlyfrom mathplug import function
- Functions should be accessed with
mathplug.function()
, notmathplug.file.function
- Functions should be optionally imported with
- Agregated all test files into one file containing all tests
- Done for ease of use and to clean up file tree
- Incremented version number
0.0.3
(10.26.2020)
- More math functions defined
-
absolute()
,cube()
, andexponent()
-
- Created tests for new functions & tested with
PyTest
-
absolute()
,cube()
, andexponent()
-
- Incremented version number
0.1.0
(Planned)
- Stable release
- Improve Python accessability
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.