An open API service indexing awesome lists of open source software.

https://github.com/package-url/purl-spec

A minimal specification for purl aka. a package "mostly universal" URL, join the discussion at https://gitter.im/package-url/Lobby
https://github.com/package-url/purl-spec

cyclonedx dependencies package package-management package-url purl sbom spdx url

Last synced: 26 days ago
JSON representation

A minimal specification for purl aka. a package "mostly universal" URL, join the discussion at https://gitter.im/package-url/Lobby

Awesome Lists containing this project

README

          

# Development setup and instructions

We use some code:

- to validate the JSON schemas for correctness and format them, and
- to validate that the test suite data files are schema-valid.

To setup an environment to contribute to the Package-URL spec and standard, follow these
instructions:

## Setup

1. Ensure that you have a recent Python version 3 and Make installed.
2. Configure your environment:

```bash
make conf
```

## Usage

To validate that the schemas and data files are correct, run:

```bash
make check
```

To regenerate the Python utility model code from the JSON schemas, then regenerate the
PURL type documentation from the JSON PURL type definition files, run:

```bash
make generate
make docs
```