Metadata-Version: 2.1
Name: totemp
Version: 0.3.0
Summary: Temperature Converter
Home-page: https://github.com/eddyyxxyy/ToTemp
License: GPL-3.0-only
Keywords: converter,temperature,celsius,kelvin,fahrenheit,rankine,delisle,Newton,Réaumur,Rømer
Author: Edson Pimenta
Author-email: edson.tibo@gmail.com
Maintainer: Edson Pimenta
Maintainer-email: edson.tibo@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown

# ToTemp
<div style="display: inline-block">
  <img src="https://shields.io/pypi/v/totemp"  alt="package version"/>
  <img src="https://img.shields.io/pypi/l/totemp.svg"  alt="license"/>
</div>

**ToTemp** is a temperature conversion package between Celcius, Delisle, Fahrenheit, Kelvin, Rankine, Reaumur, Newton and Romer

## Usage

First of all, install the package:

```
pip install totemp
```

or, to have an example in poetry environments:

```
poetry add --group dev totemp
```

Then, just use it:

> In these examples, you can observe the methods working with both
Classes available in the package

````python
# Import Celcius class
from totemp import Celsius

temperature = Celsius.to_fahrenheit(35)
print(temperature)  # 95.0 -> float

temperature = Celsius.to_fahrenheit(35, float_ret=False)
print(temperature)  # 95 -> int
````
````python
# Import Fahrenheit class
from totemp import Fahrenheit

temperature = Fahrenheit.to_newton(18.746)
print(temperature)  # -2.4299000000000004 -> float

temperature = Fahrenheit.to_newton(18.746, float_ret=False)
print(temperature)  # -2 -> int
````
````python
# Import all classes (not recommended)
from totemp import *

temperature = Celsius.to_delisle(345.797)
print(temperature)  # -368.69550000000004 -> float

temperature = Celsius.to_delisle(345.797, float_ret=False)
print(temperature)  # -368 -> int

temperature = Fahrenheit.to_rankine(500)
print(temperature)  # 959.6700000000001 -> float

temperature = Fahrenheit.to_rankine(500, float_ret=False)
print(temperature)  # 959 -> int
````

Note that **all returns are *float values*** if you dont specify "float_ret"
parameter as False, which is True by default and that **applies to all methods**.

All methods have two parameters, the **value** (which is positional-only)
and the **return type** (which is <float_ret>, that is by default True to return float
values and keyword-only)

## Package Versions

---

- _0.1.0_:
  - Yanked, not functional;
- _0.2.0_:
  - Functional;
  - Can convert Celsius to Delisle, Fahrenheit, Kelvin, Newton, Rankine, Réaumur and Rømer.


- **0.3.0**:
  - Changed methods implementations and adds Fahrenheit conversions;
    - <scale_value> parameter is now positional-only;
    - Adds new paramater -> float_ret -> Float Return (True by default, keyword-only);
    - Celsius class methods were updated and enhanced;
    - Can now convert Fahrenheit to Celsius, Delisle, Kelvin, Newton, Rankine, Réaumur and Rømer.

---

## License

For more information, check LICENSE file.

