reqver

A command-line tool to add version information to requirements.txt files.

Usage

reqver <params> files

For more information, please refer to the documentation.

reqver

Latest version: 0.1.7

A command-line tool to add version information to requirements.txt files.

Installation

pip install reqver

Usage

reqver [OPTIONS] [FILES]...

If no files are given, reqver looks for requirements.txt in the current directory. If not found, it searches parent directories. If still not found, it displays an error message.

Options:

• --force: Force update of all package versions, even if they already have version information.
• --no-backups: Do not create backup files when updating requirements files.

Examples:

1. Process requirements.txt in the current directory:

   reqver
   

2. Process a specific requirements file:

   reqver path/to/requirements.txt
   

3. Process multiple requirements files:

   reqver req1.txt req2.txt
   

4. Force update all versions:

   reqver --force requirements.txt
   

5. Update without creating backups:

   reqver --no-backups requirements.txt
   

Behavior

For each specified file (or the found requirements.txt):

1. Treats it as a requirements file (if it is a text file).
2. For each requirement in the file:
   • If version info is present: leaves it as is, unless the --force option is set.
   • If no version info is present: gets the current version with pip.
3. Creates a backup of the old requirements file (unless --no-backups is used).
4. Writes the new requirements file with updated version information.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Running Tests

To run the tests for this project, follow these steps:

1. Ensure you have the necessary dependencies installed:

   pip install -r requirements.txt
   

2. Navigate to the root directory of the project.

3. Run the tests using Python's unittest module:

   python -m unittest discover tests
   

This will discover and run all the tests in the tests directory.

Uploading to PyPI

To upload a new version of this package to PyPI:

1. Update the version number in setup.py and reqver/__init__.py.
2. Build the package:

   python setup.py sdist
   

3. Upload to TestPyPI (optional):

   twine upload --repository testpypi dist/*
   

4. Upload to PyPI:

   twine upload dist/*
   

Make sure you have the latest versions of setuptools, wheel, and twine installed before building and uploading:

pip install --upgrade setuptools wheel twine