vereqsyn

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

The name vereqsyn stands for version.cfg reqirements.txt synchronization.

This program can be used to synchronize a versions.cfg used by zc.buildout with a requirements.txt as used by pip.

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

---

Table of Contents

• Installation
• Usage
• Constraints
• Hacking
• License

Installation

pip install vereqsyn

Usage

vereqsyn --help
vereqsyn versions.cfg requirements.txt

Constraints

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

Hacking

Run the tests

hatch run cov

Run the code formatter

To lint the code:

hatch fmt

To format the code:

hatch fmt -f

Cut a release

• Update release date and maybe version number in Changes.md.

• Commit changes.

• Create a git tag.

• hatch build

• cd dist
  twine upload -r pypi *
  rm vereqsyn-*

• hatch version <new version number>

• Update Changes.md: Enter new version as unreleased.

• Commit and push changes.

License

vereqsyn is distributed under the terms of the MIT license.