Skip to content

Commit

Permalink
Final Commit
Browse files Browse the repository at this point in the history
  • Loading branch information
junioralive committed Aug 6, 2024
1 parent 2d96d1a commit 2acd8b4
Show file tree
Hide file tree
Showing 15 changed files with 84 additions and 19 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist/
63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# MathMagic 🧙‍♂️✨

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.

## Introduction 📘

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.

## Features 🔥

- Basic arithmetic operations:
- Addition ➕
- Subtraction ➖
- Multiplication ✖️
- Division ➗
- Floor Division 🧱
- Modulus 🔣
- Square Root √
- Easy to install 💾
- Simple to use in any Python project 🐍

## Installation 💻

To install `mathmagic`, clone this repository and run the installation command from the root directory of the project:

```bash
curl -LO https://github.com/junioralive/math-magic/releases/download/1.0.0/mathmagic-1.0.0-py3-none-any.whl
pip install mathmagic-1.0.0-py3-none-any.whl
```

## Usage 📚

Once installed, you can use the `mathmagic` library in your Python scripts as follows:

```python
import mathmagic

# Perform addition
result = mathmagic.add_numbers(1, 2)
print("The result of addition is:", result)

# Additional functions can be used similarly
```

## Contributors 👥

Thanks to the following people for creating this project.

<a href="https://github.com/junioralive/math-magic/graphs/contributors">
<img src="https://contrib.rocks/image?repo=junioralive/math-magic" />
</a>

## Learning Resources 📖

For those new to GitHub or collaborative software development, here are a few resources to get you started:

- [GitHub's Hello World Guide](https://guides.github.com/activities/hello-world/)
- [Understanding the GitHub flow](https://guides.github.com/introduction/flow/)
- [Forking Projects on GitHub](https://guides.github.com/activities/forking/)

## License 📄

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
7 changes: 0 additions & 7 deletions main.py

This file was deleted.

7 changes: 7 additions & 0 deletions mathmagic/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from .addition import add_numbers
from .division import divide_numbers
from .subtraction import subtracte_numbers
from .multiplication import multiply_numbers
from .modulus import modulus_numbers
from .floordivision import floor_division_numbers
from .squareroot import square_root_number
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions mathmagic/modulus.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
def modulus_numbers(a, b):
return a % b
File renamed without changes.
File renamed without changes.
File renamed without changes.
12 changes: 0 additions & 12 deletions scripts/Modulus.py

This file was deleted.

Binary file removed scripts/__pycache__/addition.cpython-311.pyc
Binary file not shown.
Binary file removed scripts/__pycache__/division.cpython-311.pyc
Binary file not shown.
11 changes: 11 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
from setuptools import setup, find_packages

setup(
name='mathmagic',
version='1.0.0',
packages=find_packages(),
author='Marvns',
author_email='unknown@unknown.com',
description='A simple math package',
python_requires='>=3.6',
)

0 comments on commit 2acd8b4

Please sign in to comment.