@@ -57,7 +57,7 @@ The implementation is based on the descriptive Markdown files in the repository
5757As always you should work in a virtualenv (venv). You can install a local clone
5858of this repo with ` yourenv/bin/pip install . ` or install it from PyPI
5959(check for the [ newest release] ( https://pypi.org/project/spdx-tools/#history ) and install it like
60- ` yourenv/bin/pip install spdx-tools==0.8.0a2 ` ). Note that on Windows it would be ` Scripts `
60+ ` yourenv/bin/pip install spdx-tools==0.8.3 ` ). Note that on Windows it would be ` Scripts `
6161instead of ` bin ` .
6262
6363## How to use
@@ -69,33 +69,33 @@ instead of `bin`.
6969 - Use ` pyspdxtools -i <filename> ` where ` <filename> ` is the location of the file. The input format is inferred automatically from the file ending.
7070
7171 - If you are using a source distribution, try running:
72- ` pyspdxtools -i tests/data/SPDXJSONExample-v2.3.spdx.json `
72+ ` pyspdxtools -i tests/spdx/ data/SPDXJSONExample-v2.3.spdx.json `
7373
74742 . ** CONVERTING** (for converting one format to another):
7575
7676 - Use ` pyspdxtools -i <input_file> -o <output_file> ` where ` <input_file> ` is the location of the file to be converted
7777 and ` <output_file> ` is the location of the output file. The input and output formats are inferred automatically from the file endings.
7878
7979 - If you are using a source distribution, try running:
80- ` pyspdxtools -i tests/data/SPDXJSONExample-v2.3.spdx.json -o output.tag `
80+ ` pyspdxtools -i tests/spdx/ data/SPDXJSONExample-v2.3.spdx.json -o output.tag `
8181
8282 - If you want to skip the validation process, provide the ` --novalidation ` flag, like so:
83- ` pyspdxtools -i tests/data/SPDXJSONExample-v2.3.spdx.json -o output.tag --novalidation `
83+ ` pyspdxtools -i tests/spdx/ data/SPDXJSONExample-v2.3.spdx.json -o output.tag --novalidation `
8484 (use this with caution: note that undetected invalid documents may lead to unexpected behavior of the tool)
8585
8686 - For help use `pyspdxtools --help`
8787
88883 . ** GRAPH GENERATION** (optional feature)
8989
9090 - This feature generates a graph representing all elements in the SPDX document and their connections based on the provided
91- relationships. The graph can be rendered to a picture. Below is an example for the file ` tests/data/SPDXJSONExample-v2.3.spdx.json ` :
91+ relationships. The graph can be rendered to a picture. Below is an example for the file ` tests/spdx/ data/SPDXJSONExample-v2.3.spdx.json ` :
9292 ![ SPDXJSONExample-v2.3.spdx.png] ( assets/SPDXJSONExample-v2.3.spdx.png )
9393
9494 - Make sure you install the optional dependencies ` networkx ` and ` pygraphviz ` . To do so run ` pip install ".[graph_generation]" ` .
9595 - Use ` pyspdxtools -i <input_file> --graph -o <output_file> ` where ` <output_file> ` is an output file name with valid format for ` pygraphviz ` (check
9696 the documentation [ here] ( https://pygraphviz.github.io/documentation/stable/reference/agraph.html#pygraphviz.AGraph.draw ) ).
9797 - If you are using a source distribution, try running
98- ` pyspdxtools -i tests/data/SPDXJSONExample-v2.3.spdx.json --graph -o SPDXJSONExample-v2.3.spdx.png ` to generate
98+ ` pyspdxtools -i tests/spdx/ data/SPDXJSONExample-v2.3.spdx.json --graph -o SPDXJSONExample-v2.3.spdx.png ` to generate
9999 a png with an overview of the structure of the example file.
100100
101101### Library usage
0 commit comments