publiccode.yml parser for Go

A Go parser and validator for publiccode.yml files.

publiccode.yml is an international standard for describing public software, which should be placed at the root of Free/Libre and Open Source software repositories.

This parser performs syntactic and semantic validation according to the official spec.

Features

• Support for the Italian extension
• Check ISO 3166-1 alpha-2 and alpha-3 country codes
• Validate emails, URLs (http scheme, valid status code), local and remote files, dates as "YYYY-MM-DD", images (colors, mimes)
• Check pa-types
• Validate oembed video links and retrieve HTML for easy embedding
• Validate SPDX licenses. Without WITH keyword.
• Check tags

Example

parser := publiccode.NewParser("file:///path/to/local/dir/publiccode.yml")
// OR
// parser := publiccode.NewParser("https://github.com/example/example//publiccode.yml")

// all these settings are optional:
parser.DisableNetwork = true
parser.Branch = "mybranch"

err := parser.Parse()
publiccode := parser.PublicCode

Validation from command line

This repository also contains pcvalidate which can be used for validating a publiccode.yml from the command line.

To get the latest development version use:

go install github.com/italia/publiccode-parser-go/v3/pcvalidate@latest
pcvalidate mypubliccode.yml

To get the latest stable version go to the release page and grab the one for your arch.

Run pcvalidate --help for the available command line flags.

The tool returns 0 in case of successful validation, 1 otherwise.

Easy validation with Docker

You can easily validate your files using Docker on your local machine or in your CI pipeline:

docker run -i italia/publiccode-parser-go /dev/stdin < publiccode.yml

The image is available on Dockerhub. You can also build your own running:

docker build -t italia/publiccode-parser-go .

Examples

The examples assume that your publiccode.yml file is on your local machine, at /home/my-user/publiccodes/publiccode.yml

• Validate and print the canonicalized file

  docker run -i italia/publiccode-parser-go -export /dev/stdout /dev/stdin < publiccode.yml

• Validate a publiccode file named publiccode.yml in /home/user

  docker run -v /home/user:/go/src/files italia/publiccode-parser-go

• Validate a publiccode file named /opt/publiccodes/my-amazing-code.yaml

  docker run -v /opt/publiccodes:/go/src/files italia/publiccode-parser-go my-amazing-code.yaml

• Validate publiccode.yml without using the network (fe. checking URLs are reachable)

  docker run -v /opt/publiccodes/publiccodes:/files italia/publiccode-parser-go -no-network publiccode.yml

• Debugging, access the container interactive shell, overriding the entrypoint

  docker run -it --entrypoint /bin/sh italia/publiccode-parser-go

Contributing

Contributing is always appreciated. Feel free to open issues, fork or submit a Pull Request. If you want to know more about how to add new fields, check out CONTRIBUTING.md. In order to support other country-specific extensions in addition to Italy some refactoring might be needed.

See also

• Developers Italia backend & crawler - a Go crawler that uses this library

Maintainers

This software is maintained by the Developers Italia team.

License

© 2018-2020 Team per la Trasformazione Digitale - Presidenza del Consiglio dei Minstri

Licensed under the EUPL. The version control system provides attribution for specific lines of code.