<h1 align="center" style="font-weight: bold;">Metricus</h1>

[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
[![PyPi license](https://badgen.net/pypi/license/pip/)](https://pypi.org/project/pip/)
[![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/Naereen/badges/)

<p align="center">
 <a href="#started">Getting Started</a> • 
 <a href="#colab">Collaborators</a> •
 <a href="#contribute">Contribute</a> •
 <a href="#license">License</a> •
 <a href="#preview">Preview</a>
</p>

<p align="center">
  <b>This Python-based unit converter is a simple and efficient tool for converting measurements between various units, such as force, length, mass, and others, including complex operations like displacement. It features an intuitive graphical user interface built with Tkinter, allowing users to navigate and perform conversions easily. The converter returns precise results, formatted with or without the unit abbreviation for easy readability.
  </b>
</p>

<h2 id="started">🚀 Getting started </h2>

```bash
pip install metricus
```

### Usage Example
```python
from Metricus.gui import MetricusGUI
from Metricus import temperature_converter
from Metricus.utilities import round_number, humanize_input, decomputarize_input, plot_temperature_variation

# ----------------------------
# Temperature Conversion Example
# ----------------------------
temp_celsius = 25
temp_rankine = temperature_converter(temp_celsius, 'celsius', 'rankine')
print(f"{temp_celsius} degrees Celsius equals {temp_rankine} Rankine")

# ----------------------------
# Time Conversion Examples
# ----------------------------

# Example 1: Basic usage
time_seconds = 3600
time_hours = time_converter(time_seconds, 'second', 'hour')
print(f"{time_seconds} seconds equals {time_hours} hours")

# Example 2: Using rounded_result
time_days = 365
time_year = time_converter(time_days, 'day', 'year', rounded_result=True)
print(f"{time_days} days equals {time_year} year")

# Example 3: Using humanized_input
time_years = 100
time_century = time_converter(time_years, 'year', 'century', humanized_input=True)
print(f"{time_years} years equals {time_century} century")

# ----------------------------
# Displacement Calculation Example
# ----------------------------
length_kilometers = 100
speed_kmh = 100
time_unit = 'minute'
result = calculate_displacement(length=length_kilometers, speed=speed_kmh, time_unit=time_unit)
print(f"Covering {length_kilometers} km at a speed of {speed_kmh} km/h takes {result} minutes.")

# ----------------------------
# Number Rounding Example
# ----------------------------
# Rounding a numeric result
time_days = 365
time_result = time_converter(time_days, 'day', 'year')
rounded_number = round_number(time_result)
print(f"The number {time_result} rounded is {rounded_number}")

# Rounding a string result
time_result_with_unit = time_converter(time_days, 'day', 'year', with_unit=True)
rounded_number_with_unit = round_number(time_result_with_unit)
print(f"The number {time_result_with_unit} rounded is {rounded_number_with_unit}")

# ----------------------------
# Humanizing and Decomputadorizing Input
# ----------------------------
from_acceleration = 'Meter per second squared'
to_acceleration = 'Foot per second squared'

# Humanizing input
acceleration_result = acceleration_converter(
    100,
    humanize_input(from_acceleration),
    humanize_input(to_acceleration)
)
print(f"The conversion result from {from_acceleration} to {to_acceleration} is {acceleration_result}")

# Decomputadorizing input
decomputarized_from = decomputarize_input(humanize_input(from_acceleration))
decomputarized_to = decomputarize_input(humanize_input(to_acceleration))
print(f"The decomputarized input from '{humanize_input(from_acceleration)}' is '{decomputarized_from}'")
print(f"The decomputarized input to '{humanize_input(to_acceleration)}' is '{decomputarized_to}'")

# ----------------------------
# Temperature Variation Plotting Examples
# ----------------------------
# Daily temperatures for 30 days (based on the provided list)
temperatures = [
    15.3, 16.1, 14.8, 13.5, 12.4, 11.8, 13.0, 15.5, 16.2, 14.9,
    13.0, 12.5, 11.6, 13.4, 15.1, 11.0, 17.2, 18.5, 19.0, 18.3,
    17.8, 16.4, 15.0, 14.2, 13.6, 12.7, 13.8, 14.5, 15.2, 16.0
]

# Example 1: Basic usage - Plot in Celsius with statistical info
plot_temperature_variation(
    temperatures=temperatures,
    temperature_unit='celsius'
)

# Example 2: Convert temperatures to Fahrenheit
plot_temperature_variation(
    temperatures=temperatures,
    temperature_unit='celsius',
    convert_to='fahrenheit'
)

# Example 3: Disable statistical information
plot_temperature_variation(
    temperatures=temperatures,
    temperature_unit='celsius',
    convert_to='fahrenheit',
    with_info=False
)

# Example 4: Save the graph to a file
plot_temperature_variation(
    temperatures=temperatures,
    temperature_unit='celsius',
    convert_to='fahrenheit',
    save_path='temperature_variation.png'
)

# Example 5: Save graph in Kelvin with statistics
plot_temperature_variation(
    temperatures=temperatures,
    temperature_unit='celsius',
    convert_to='kelvin',
    save_path='temperature_variation_kelvin.pdf',
    with_info=True
)

# ----------------------------
# Launching the Graphical Interface
# ----------------------------
MetricusGUI()
```

<h2 id="preview">🌟 Preview</h2>

Below is a preview of the Metricus graphical user interface (GUI):
<p align="center">Simple Conversions:</p>
<p align="center">
  <img src="assets/metricus.gif" alt="Metricus GUI" width="60%">
</p>
<p align="center">Complex Conversions:</p>
<p align="center">
  <img src="assets/metricus_complex.gif" alt="Metricus GUI" width="60%">
</p>

The GUI is built with Tkinter and provides an intuitive way to perform unit conversions quickly and accurately.

<h3>Prerequisites</h3>

- Python 3.8+
- Matplotlib

<h3>Cloning</h3>

```bash
git clone https://github.com/guifreschi/Metricus
```

<h3>Starting</h3>

Clone the repository
git clone https://github.com/guifreschi/Metricus

Navigate into the project directory
cd Metricus

Create a virtual environment
python -m venv venv

Activate the virtual environment
- On Windows
venv\Scripts\activate
- On Unix or MacOS
source venv/bin/activate

Install Metricus
pip install -e .

<h2 id="colab">🤝 Collaborators</h2>

This project is maintained and created by:

<table>
  <tr>
    <td align="center">
      <a href="https://github.com/guifreschi">
        <img src="https://avatars.githubusercontent.com/u/181294670?v=4" width="100px;" alt="Guilherme Freschi Profile Picture"/><br>
        <sub>
          <b>Guilherme Freschi</b>
        </sub>
      </a>
    </td>
    <td align="center">
      <a href="https://github.com/YaronBuchler">
        <img src="https://avatars.githubusercontent.com/u/185246229?v=4" width="100px;" alt="Yaron Buchler Profile Picture"/><br>
        <sub>
          <b>Yaron Buchler</b>
        </sub>
      </a>
    </td>
  </tr>
</table>

<h2 id="contribute">📫 Contribute</h2>

1. `git clone https://github.com/guifreschi/Metricus`
2. `git checkout -b feature/NAME`
3. Follow commit patterns
4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

<h3>Documentations that might help</h3>

[📝 How to create a Pull Request](https://www.atlassian.com/br/git/tutorials/making-a-pull-request)

[💾 Commit pattern](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716)

<h2 id="license">📝 License</h2>

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
