An open API service indexing awesome lists of open source software.

https://github.com/junioralive/math-magic

A simple math package
https://github.com/junioralive/math-magic

collaboration education github-tutorial math-library math-magic math-operations mathmagic python

Last synced: 7 months ago
JSON representation

A simple math package

Awesome Lists containing this project

README

          

# 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.



## 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.