Metadata-Version: 2.4
Name: clickqt-utils
Version: 0.1.0
Summary: Some click utilities that are understood by clickqt
Maintainer-email: Dominic Kempf <ssc@uni-heidelberg.de>
License-Expression: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: click
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Dynamic: license-file

# Welcome to clickqt-utils

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ssciwr/clickqt-utils/ci.yml?branch=main)](https://github.com/ssciwr/clickqt-utils/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/ssciwr/clickqt-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/ssciwr/clickqt-utils)
[![PyPI version](https://img.shields.io/pypi/v/clickqt-utils)](https://pypi.org/project/clickqt-utils/)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/clickqt-utils.svg)](https://anaconda.org/conda-forge/clickqt-utils)

A collection of `click` utilities that is also understood by `clickqt`.

## Features

Currently, `clickqt-utils` contains the following utilities:

* `PathWithExtensions`: a `click.Path` type that only accepts files with configured extensions.

They are usable with any CLI written in `click`, but they have the advantage
of being directly understood by `clickqt`. Notably, this package does not
depend on `clickqt`, so depending on this will not make you depend on QT,
but your users can opt into using `clickqt` for GUI support of your tools.

## Installation

The Python package `clickqt-utils` can be installed from PyPI:

```
python -m pip install clickqt-utils
```

## Acknowledgments

This repository was set up using the [SSC Cookiecutter for Python Packages](https://github.com/ssciwr/cookiecutter-python-package).
