Metadata-Version: 2.1
Name: precommend
Version: 0.2.0
Summary: Opinionated initialization of pre-commit configurations
Maintainer-email: Dominic Kempf <ssc@iwr.uni-heidelberg.de>
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md
License-File: COPYING.md
Requires-Dist: click
Requires-Dist: identify>=2.5.35
Requires-Dist: pre-commit>=3.6.2
Requires-Dist: ruamel.yaml
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"

# Welcome to precommend

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

`precommend` bootstraps [pre-commit](https://pre-commit.com) configurations based
on the content of your project and the recommendations of the [Scientific Software Center](https://ssc.uni-heidelberg.de).

## Installation

The Python package can be installed with

```
python -m pip install precommend
```

## Usage

Head to a directory that you want to add a config file to and run

```bash
precommend
```

## Acknowledgments

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