Skip to content

Commit 25014f9

Browse files
committed
add doc
1 parent f0762d7 commit 25014f9

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

scripts/populate_tox/dependencies.py

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
1+
# The DEPENDENCIES dictionary defines the test dependencies of each integration
2+
# test suite.
3+
#
4+
# The format is:
5+
# ```
6+
# integration_name: {
7+
# "package": name_of_main_package_on_pypi,
8+
# "deps": {
9+
# rule1: [package1, package2, ...],
10+
# rule2: [package3, package4, ...],
11+
# }
12+
# }
13+
# ```
14+
#
15+
# The following can be set as a rule:
16+
# - `*`: packages will be always installed
17+
# - a version bound on the main package (e.g. `<=0.32`): packages will only be installed if the main package falls into the version bounds specified
18+
# - specific Python version(s) in the form `py3.8,py3.9`: packages will only be installed if the Python version matches one from the list
19+
#
20+
# Rules can be used to specify version bounds on older versions of the main
21+
# package's dependencies, for example. If e.g. Flask tests generally need
22+
# Werkzeug and don't care about its version, but Flask older than 3.0 needs
23+
# a specific Werkzeug version to work, you can say:
24+
#
25+
# ```
26+
# "flask": {
27+
# "deps": {
28+
# "*": ["Werkzeug"],
29+
# "<3.0": ["Werkzeug<2.1.0"],
30+
# }
31+
# }
32+
# ````
33+
34+
135
DEPENDENCIES = {
236
"aiohttp": {
337
"package": "aiohttp",

0 commit comments

Comments
 (0)