avnum

A simple Python module to calculate the average of numbers.

PyPi · Discord · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Examples
5. Contributing
6. License
7. Contact

About The Project

The avnum project was created to make developers' lives easier

The avnum module was developed and published by Andrei Motin in summer 2024

The name avnum stands for Average Number and is here to help you calculate the average of given numbers

The module is super versatile, you can use it with predefined lists or in the function directly, however you want!

Hop right to Getting Started to begin your adventure with avnum.

Built With

avnum is based on Python, and your contributions 😄

(back to top)

Getting Started

Prerequisites

• Python 3.6 or above

Installation

Install the module

pip install avnum --upgrade

(back to top)

Usage

# Import the module
import avnum
# Use the module
avnum.average()

For any questions feel free to reach out to me at Contact

(back to top)

Examples

Example with a predefined number list and a print output

import avnum
list = [1, 2, 3]
num_average = avnum.average(list)
print(output)

Example with no predefined number list and no output

import avnum
avnum.average(5, 10, 17)

Feel free to experiment with the avnum module, and if any problems appear, hit me up at Contact

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repository and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

To contribute:

1. Fork the repository
2. Clone the forked repository (git clone https://github.com/andreimotin/avnum)
3. Create your branch (git branch BRANCH-NAME, git checkout BRANCH-NAME)
4. Change something you'd like
5. Add your changes to your branch (git add .)
6. Commit your Changes (git commit -m "a short description of the change")
7. Push your changes to your branch (git push)
8. Open a Pull Request

Full guide available here: Contributing Guide

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Twitter: @andreimotin12

Discord: https://discord.gg/9nUr8feRa3

Email: motinandrei@icloud.com

Project Link: https://github.com/andreimotin/avnum

(back to top)