summaryrefslogtreecommitdiff
path: root/misc/requirements/README.md
blob: 330233bcad305f9bf84c4169647baf20d1e77d18 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
```