11# spdx-python-model
22
3- Generated Python code for SPDX Spec version 3
3+ Generated Python code for SPDX specification version 3.
44
55All bindings in this repository are generated using
66[ shacl2code] ( https://github.com/JPEWdev/shacl2code ) at the time the package is
@@ -10,10 +10,10 @@ built.
1010manipulating SPDX files. While they are fully functions, they lack higher level
1111helper functions that may be useful for creating SPDX documents. If you want a
1212higher level approach, please see the
13- [ SPDX Python Tools] ( https://github.com/spdx/tools-python ) (however this repo
13+ [ SPDX Python Tools] ( https://github.com/spdx/tools-python ) (however that project
1414doesn't yet support SPDX 3)
1515
16- ## Installation (PyPi )
16+ ## Installation (PyPI )
1717
1818``` shell
1919python3 -m pip install spdx-python-model
@@ -22,7 +22,7 @@ python3 -m pip install spdx-python-model
2222## Installation (Git)
2323
2424If you would like to pull the bindings directly from Git instead of using a
25- released version from PyPi , the following command can be used:
25+ released version from PyPI , the following command can be used:
2626
2727``` shell
2828python3 -m pip install git+https://github.com/spdx/spdx-python-model.git@main
@@ -52,6 +52,11 @@ from spdx_python_model import v3_0_1 as spdx_3_0
5252p = spdx_3_0.Person()
5353```
5454
55+ Check out this short [ Python notebook tutorial] [ tutorial ]
56+ to get started with spdx-python-model.
57+
58+ [ tutorial ] : https://gist.github.com/bact/7227ad858500c2097a25344a4af015d6
59+
5560## Testing
5661
5762This repository has support for running tests against the bindings using ` pytest ` .
@@ -78,4 +83,4 @@ make a new release in GitHub with the name `v` + *VERSION*, where *VERSION*
7883matches the version number specified in ` version.py ` (e.g. ` v1.0.0 ` ).
7984
8085After this, GitHub actions will do the rest to build the package and publish it
81- to PyPi
86+ to PyPI.
0 commit comments