qutebrowser/misc/requirements/README.md

1.0 KiB

This directory contains various requirements files which are used by tox to have reproducible tests with pinned versions.

The files are generated based on unpinned requirements in *.txt-raw files.

Those files can also contain some special commands:

  • Add an additional comment to a line: #@ comment: <package> <comment here>
  • Filter a line for requirements.io: #@ filter: <package> <filter>
  • Don't include a package in the output: #@ ignore: <package> (or multiple packages)
  • Replace a part of a frozen package specification with another: #@ replace: <regex> <replacement>
  • Add a new line: #@ add: <line>
  • Add environment markers to a line: #@ markers: <package> <markers>

Some examples:

#@ comment: mypkg blah blub
#@ filter: mypkg != 1.0.0
#@ ignore: mypkg, otherpkg
#@ replace: foo bar

## Use the marker line to restrict the unpinned Flask requirement to python
## 3.7. For python 3.7 add a specific version into the output.
Flask
# Python 3.7
#@ markers: Flask python_version>="3.7"
#@ add: Flask==2.2.5 ; python_version=="3.7.*"