Metadata-Version: 2.1
Name: vereqsyn
Version: 0.9
Summary: Bi-directional version.cfg <–> requirements.txt synchronization
Project-URL: Documentation, https://github.com/minddistrict/vereqsyn#readme
Project-URL: Issues, https://github.com/minddistrict/vereqsyn/issues
Project-URL: Source, https://github.com/minddistrict/vereqsyn
Project-URL: changelog, https://github.com/minddistrict/vereqsyn/CHANGES.md
Author-email: Michael Howitz <icemac@gmx.net>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.11
Requires-Dist: packaging
Description-Content-Type: text/markdown

# vereqsyn

[![PyPI - Version](https://img.shields.io/pypi/v/vereqsyn.svg)](https://pypi.org/project/vereqsyn)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vereqsyn.svg)](https://pypi.org/project/vereqsyn)

Bi-directional version.cfg <–> requirements.txt synchronization

This program can be used to synchronize a `versions.cfg` used by
[zc.buildout](https://pypi.org/project/zc.buildout/) with a `requirements.txt`
as used by [pip](https://pypi.org/project/pip/).

This is be helpful to keep using `zc.buildout` but get version updates via
GitHub's Dependabot.

-----

**Table of Contents**

- [Installation](#installation)
- [Usage](#usage)
- [Constraints](#constraints)
- [Hacking](#hacking)
- [License](#license)

## Installation

```console
pip install vereqsyn
```

## Usage

```console
vereqsyn --help
vereqsyn versions.cfg requirements.txt
```

## Constraints

* `version.cfg` is the source of truth. `requirements.txt` can get recreated.
* So `version.cfg` can contain comments, the ones in `requirements.txt` are
  lost when running recreate.

## Hacking

### Run the tests

```console
hatch run cov
```

## License

`vereqsyn` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
