Skip to content

Commit 46c598d

Browse files
committed
Track the xml2rfc dependency using a requirements.txt file
The standard practice for tracking dependencies on Python projects is to declare the dependencies and the expected versions on a `requirements.txt` file that is read by `pip`. Right now, we request people to manually install the latest version of `xml2rfc`. After this commit, we properly track `xml2rfc` on `requirements.txt` and tweak the documentation a bit to show users how to install it from there instead. Signed-off-by: Juan Cruz Viotti <[email protected]>
1 parent 00f22bc commit 46c598d

File tree

3 files changed

+64
-1
lines changed

3 files changed

+64
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,14 @@ Labels are assigned based on [Sensible Github Labels](https://github.com/Releque
3535
* links.json - JSON Hyper-Schema's Link Description Object meta-schema
3636
* hyper-schema-output.json - The recommended output format for JSON Hyper-Schema links
3737

38-
Install "xml2rfc" using "pip" (https://pypi.org/project/xml2rfc/) and type "make" at a shell to build the .txt and .html spec files.
38+
Install "xml2rfc" using "pip" (https://pypi.org/project/xml2rfc/) and type "make" at a shell to build the .txt and .html spec files:
39+
40+
```sh
41+
pip install --requirement requirements.txt
42+
make
43+
```
44+
45+
The version of "xml2rfc" that this project uses is updated by modifying `requirements.in` and running `pip-compile requirements.in`.
3946

4047
Descriptions of the xml2rfc, I-D documents, and RFC processes:
4148

requirements.in

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
xml2rfc>=3.12.0

requirements.txt

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
#
2+
# This file is autogenerated by pip-compile with python 3.9
3+
# To update, run:
4+
#
5+
# pip-compile requirements.in
6+
#
7+
appdirs==1.4.4
8+
# via xml2rfc
9+
certifi==2022.6.15
10+
# via requests
11+
charset-normalizer==2.1.0
12+
# via requests
13+
configargparse==1.5.3
14+
# via xml2rfc
15+
google-i18n-address==2.5.2
16+
# via xml2rfc
17+
html5lib==1.1
18+
# via xml2rfc
19+
idna==3.3
20+
# via requests
21+
intervaltree==3.1.0
22+
# via xml2rfc
23+
jinja2==2.11.3
24+
# via xml2rfc
25+
kitchen==1.2.6
26+
# via xml2rfc
27+
lxml==4.9.1
28+
# via xml2rfc
29+
markupsafe==2.1.1
30+
# via jinja2
31+
pycountry==22.3.5
32+
# via xml2rfc
33+
pyflakes==2.4.0
34+
# via xml2rfc
35+
pyyaml==6.0
36+
# via xml2rfc
37+
requests==2.28.1
38+
# via
39+
# google-i18n-address
40+
# xml2rfc
41+
six==1.16.0
42+
# via
43+
# html5lib
44+
# xml2rfc
45+
sortedcontainers==2.4.0
46+
# via intervaltree
47+
urllib3==1.26.10
48+
# via requests
49+
webencodings==0.5.1
50+
# via html5lib
51+
xml2rfc==3.12.0
52+
# via -r requirements.in
53+
54+
# The following packages are considered to be unsafe in a requirements file:
55+
# setuptools

0 commit comments

Comments
 (0)