Skip to content

Commit 07c3172

Browse files
committed
Add netrc file option in doc
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
1 parent cbd957e commit 07c3172

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

docs/source/test-protocol.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ file, using each time a different output file name. We assume here Python
8080
version 3.8 (note the absence of dot when passed as a command line option::
8181

8282
dad --python-version 38 --requirement <path/to/requirements.txt> \
83-
--json <path/to/resolved-requirements.txt.json>
83+
--json <path/to/resolved-requirements.txt.json> \
84+
--netrc <path/to/.netrc>
8485

8586
The output is a list of JSON files with resolved packages for each of the
8687
input requirements files.
@@ -92,17 +93,17 @@ Step 5: Collect expected resolved packages
9293
In this step, you need to collect the list of built packages "purl" found in
9394
the top level "packages" attribute of the JSON scan output from Step 3.
9495

95-
The output is a list of expected purl with a version.
96+
The output is a list of expected purls with a version.
9697

9798

9899
Step 6: Collect actual resolved packages
99100
----------------------------------------------
100101

101-
In this step, you need to collect the list of purl "package" attribute resolved
102+
In this step, you need to collect the list of purls "package" attribute resolved
102103
found in the top level "resolved_dependencies" attribute of the python-inspector
103104
resolution output from Step 4.
104105

105-
The output is a list of actual purl with a version.
106+
The output is a list of actual purls with a version.
106107

107108

108109
Step 7: Compare expected with actual resolved packages
@@ -153,7 +154,7 @@ And the reference Python version is 3.8::
153154

154155
mkdir -p ~/tmp/pyinsp-example/
155156
cd ~/tmp/pyinsp-example/
156-
git https://github.com/tjcsl/ion
157+
git clone https://github.com/tjcsl/ion
157158

158159

159160
Another example could be https://github.com/digitalocean/sample-django
@@ -256,15 +257,15 @@ Step 5: Collect expected resolved packages
256257

257258
TODO: explain how to do this in details
258259

259-
The output is a list of expected purl with a version.
260+
The output is a list of expected purls with a version.
260261

261262

262263
Step 6: Collect actual resolved packages
263264
----------------------------------------------
264265

265266
TODO: explain how to do this in details
266267

267-
The output is a list of actual purl with a version.
268+
The output is a list of actual purls with a version.
268269

269270

270271
Step 7: Compare expected with actual resolved packages

0 commit comments

Comments
 (0)