Metadata-Version: 2.1
Name: tum-esm-utils
Version: 1.5.2
Summary: Python utilities by the Professorship of Environmental Sensing and Modeling at the Technical University of Munich
Home-page: https://github.com/tum-esm/utils
License: AGPL-3.0-only
Keywords: python,library,utilities,lazydocs,docsify
Author: Moritz Makowski
Author-email: moritz.makowski@tum.de
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: filelock (>=3.10.0,<4.0.0)
Requires-Dist: pendulum (>=2.1.2,<3.0.0)
Requires-Dist: polars (>=0.17.11,<0.18.0)
Requires-Dist: psutil (>=5.9.4,<6.0.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Project-URL: Documentation, https://tum-esm.github.io/utils
Project-URL: Repository, https://github.com/tum-esm/utils
Description-Content-Type: text/markdown

# 🔬 &nbsp;TUM ESM Python Utilities

This library is a collection of small functions used in our research projects. Here, we can test and document the functions properly instead of every project dealing with this overhead which allows us to reduce the size of the utility directories of individual projects.

Feel free to use it in any other project ✨

[![PyPI](https://img.shields.io/pypi/v/tum-esm-utils?color=f43f5e)](https://pypi.org/project/tum-esm-utils)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tum-esm-utils?color=f43f5e)](https://pypi.org/project/tum-esm-utils/)
[![GitHub](https://img.shields.io/github/license/tum-esm/utils?color=f59e0b)](https://github.com/tum-esm/utils/blob/main/LICENSE)
<br/>
[![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/tum-esm/utils/test.yaml?branch=main&label=CI%20tests)](https://github.com/tum-esm/utils/actions/workflows/test.yaml)
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/tum-esm/utils?label=codeclimate%20maintainability%20rating)](https://codeclimate.com/github/tum-esm/utils)

<br/>

## For Users

Install the Python library with:

```bash
poetry add tum_esm_utils
# or
pip install tum_esm_utils
```

Use the API reference at https://tum-esm.github.io/utils.

<br/>

## For Developers

Publish the Package to PyPI:

```bash
poetry build
poetry publish
```

Serve documentation page:

```bash
docsify serve ./docs
```

