Skip to content

Add a link to tutorial in README #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bact wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add a link to tutorial in README #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# spdx-python-model

Generated Python code for SPDX Spec version 3
Generated Python code for SPDX specification version 3.

All bindings in this repository are generated using
[shacl2code](https://github.com/JPEWdev/shacl2code) at the time the package is
Expand All @@ -10,10 +10,10 @@ built.
manipulating SPDX files. While they are fully functions, they lack higher level
helper functions that may be useful for creating SPDX documents. If you want a
higher level approach, please see the
[SPDX Python Tools](https://github.com/spdx/tools-python) (however this repo
[SPDX Python Tools](https://github.com/spdx/tools-python) (however that project
doesn't yet support SPDX 3)

## Installation (PyPi)
## Installation (PyPI)

```shell
python3 -m pip install spdx-python-model
Expand All @@ -22,7 +22,7 @@ python3 -m pip install spdx-python-model
## Installation (Git)

If you would like to pull the bindings directly from Git instead of using a
released version from PyPi, the following command can be used:
released version from PyPI, the following command can be used:

```shell
python3 -m pip install git+https://github.com/spdx/spdx-python-model.git@main
Expand Down Expand Up @@ -52,6 +52,11 @@ from spdx_python_model import v3_0_1 as spdx_3_0
p = spdx_3_0.Person()
```

Check out this short [Python notebook tutorial][tutorial]
to get started with spdx-python-model.

[tutorial]: https://gist.github.com/bact/7227ad858500c2097a25344a4af015d6

## Testing

This repository has support for running tests against the bindings using `pytest`.
Expand All @@ -78,4 +83,4 @@ make a new release in GitHub with the name `v` + *VERSION*, where *VERSION*
matches the version number specified in `version.py` (e.g. `v1.0.0`).

After this, GitHub actions will do the rest to build the package and publish it
to PyPi
to PyPI.