Skip to content

Commit 2acd8b4

Browse files
author
junioralive
committed
Final Commit
1 parent 2d96d1a commit 2acd8b4

File tree

15 files changed

+84
-19
lines changed

15 files changed

+84
-19
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist/

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# MathMagic 🧙‍♂️✨
2+
3+
The `mathmagic` library is a simple Python package that provides basic mathematical operations. This project serves as a tutorial for learning how to use GitHub for collaboration, while also creating a functional library that can be extended and used in various projects.
4+
5+
## Introduction 📘
6+
7+
This project was developed as part of an educational exercise to learn how GitHub can be utilized for collaborating on code projects. It features a simple set of functions that perform arithmetic operations, which are packaged into a Python library.
8+
9+
## Features 🔥
10+
11+
- Basic arithmetic operations:
12+
- Addition ➕
13+
- Subtraction ➖
14+
- Multiplication ✖️
15+
- Division ➗
16+
- Floor Division 🧱
17+
- Modulus 🔣
18+
- Square Root √
19+
- Easy to install 💾
20+
- Simple to use in any Python project 🐍
21+
22+
## Installation 💻
23+
24+
To install `mathmagic`, clone this repository and run the installation command from the root directory of the project:
25+
26+
```bash
27+
curl -LO https://github.com/junioralive/math-magic/releases/download/1.0.0/mathmagic-1.0.0-py3-none-any.whl
28+
pip install mathmagic-1.0.0-py3-none-any.whl
29+
```
30+
31+
## Usage 📚
32+
33+
Once installed, you can use the `mathmagic` library in your Python scripts as follows:
34+
35+
```python
36+
import mathmagic
37+
38+
# Perform addition
39+
result = mathmagic.add_numbers(1, 2)
40+
print("The result of addition is:", result)
41+
42+
# Additional functions can be used similarly
43+
```
44+
45+
## Contributors 👥
46+
47+
Thanks to the following people for creating this project.
48+
49+
<a href="https://github.com/junioralive/math-magic/graphs/contributors">
50+
<img src="https://contrib.rocks/image?repo=junioralive/math-magic" />
51+
</a>
52+
53+
## Learning Resources 📖
54+
55+
For those new to GitHub or collaborative software development, here are a few resources to get you started:
56+
57+
- [GitHub's Hello World Guide](https://guides.github.com/activities/hello-world/)
58+
- [Understanding the GitHub flow](https://guides.github.com/introduction/flow/)
59+
- [Forking Projects on GitHub](https://guides.github.com/activities/forking/)
60+
61+
## License 📄
62+
63+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

main.py

Lines changed: 0 additions & 7 deletions
This file was deleted.

mathmagic/__init__.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
from .addition import add_numbers
2+
from .division import divide_numbers
3+
from .subtraction import subtracte_numbers
4+
from .multiplication import multiply_numbers
5+
from .modulus import modulus_numbers
6+
from .floordivision import floor_division_numbers
7+
from .squareroot import square_root_number

mathmagic/modulus.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
def modulus_numbers(a, b):
2+
return a % b

0 commit comments

Comments
 (0)