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