Metadata-Version: 2.1
Name: frequenz-quantities
Version: 1.0.0rc1
Summary: Types for holding quantities with units
Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
License: MIT
Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-quantities-python/
Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-quantities-python/releases
Project-URL: Issues, https://github.com/frequenz-floss/frequenz-quantities-python/issues
Project-URL: Repository, https://github.com/frequenz-floss/frequenz-quantities-python
Project-URL: Support, https://github.com/frequenz-floss/frequenz-quantities-python/discussions/categories/support
Keywords: frequenz,python,lib,library,quantities,unit,conversion
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: <4,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typing-extensions <5,>=4.5.0
Provides-Extra: dev
Requires-Dist: frequenz-quantities[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest] ; extra == 'dev'
Provides-Extra: dev-flake8
Requires-Dist: flake8 ==7.0.0 ; extra == 'dev-flake8'
Requires-Dist: flake8-docstrings ==1.7.0 ; extra == 'dev-flake8'
Requires-Dist: flake8-pyproject ==1.2.3 ; extra == 'dev-flake8'
Requires-Dist: pydoclint ==0.4.1 ; extra == 'dev-flake8'
Requires-Dist: pydocstyle ==6.3.0 ; extra == 'dev-flake8'
Provides-Extra: dev-formatting
Requires-Dist: black ==24.4.2 ; extra == 'dev-formatting'
Requires-Dist: isort ==5.13.2 ; extra == 'dev-formatting'
Provides-Extra: dev-mkdocs
Requires-Dist: Markdown ==3.6.0 ; extra == 'dev-mkdocs'
Requires-Dist: black ==24.4.2 ; extra == 'dev-mkdocs'
Requires-Dist: mike ==2.1.1 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-gen-files ==0.5.0 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-literate-nav ==0.6.1 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-macros-plugin ==1.0.5 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-material ==9.5.26 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocstrings[python] ==0.25.1 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocstrings-python ==1.10.3 ; extra == 'dev-mkdocs'
Requires-Dist: frequenz-repo-config[lib] ==0.9.2 ; extra == 'dev-mkdocs'
Provides-Extra: dev-mypy
Requires-Dist: mypy ==1.10.0 ; extra == 'dev-mypy'
Requires-Dist: types-Markdown ==3.6.0.20240316 ; extra == 'dev-mypy'
Requires-Dist: frequenz-quantities[dev-mkdocs,dev-noxfile,dev-pytest] ; extra == 'dev-mypy'
Provides-Extra: dev-noxfile
Requires-Dist: nox ==2024.4.15 ; extra == 'dev-noxfile'
Requires-Dist: frequenz-repo-config[lib] ==0.9.2 ; extra == 'dev-noxfile'
Provides-Extra: dev-pylint
Requires-Dist: frequenz-quantities[dev-mkdocs,dev-noxfile,dev-pytest] ; extra == 'dev-pylint'
Provides-Extra: dev-pytest
Requires-Dist: pytest ==8.2.2 ; extra == 'dev-pytest'
Requires-Dist: pylint ==3.2.3 ; extra == 'dev-pytest'
Requires-Dist: frequenz-repo-config[extra-lint-examples] ==0.9.2 ; extra == 'dev-pytest'
Requires-Dist: pytest-mock ==3.14.0 ; extra == 'dev-pytest'
Requires-Dist: pytest-asyncio ==0.23.7 ; extra == 'dev-pytest'
Requires-Dist: async-solipsism ==0.6 ; extra == 'dev-pytest'
Requires-Dist: hypothesis ==6.100.2 ; extra == 'dev-pytest'

# Frequenz Quantities Library

[![Build Status](https://github.com/frequenz-floss/frequenz-quantities-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-quantities-python/actions/workflows/ci.yaml)
[![PyPI Package](https://img.shields.io/pypi/v/frequenz-quantities)](https://pypi.org/project/frequenz-quantities/)
[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-quantities-python/)

## Introduction

This library provide types for holding quantities with units. The main goal is
to avoid mistakes while working with different types of quantities, for example
avoiding adding a length to a time.

It also prevents mistakes when operating between the same quantity but in
different units, like adding a power in Joules to a power in Watts without
converting one of them.

Quantities store the value in a base unit, and then provide methods to get that
quantity as a particular unit.

## Documentation

For more information on how to use this library and examples, please check the
[Documentation website](https://frequenz-floss.github.io/frequenz-quantities-python/).

## Supported Platforms

The following platforms are officially supported (tested):

- **Python:** 3.11
- **Operating System:** Ubuntu Linux 20.04
- **Architectures:** amd64, arm64

## Contributing

If you want to know how to build this project and contribute to it, please
check out the [Contributing Guide](CONTRIBUTING.md).
