Repository files navigation

A Go parser and validator forpubliccode.ymlfiles.

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

This parser performs syntactic and semantic validation according to theofficial spec.

• Go library and CLI tool (publiccode-parser)
• Supports the latest version of thepubliccode.yml Standard
• publiccode-parser can output validation errors as JSON or inerrorformatfriendly way
• Verifies the existence of URLs by checking the response for URL fields(can be disabled)

parser,err:=publiccode.NewDefaultParser()// error handlingpubliccode,err:=parser.Parse("file:///path/to/local/dir/publiccode.yml")// OR// parse.Parse("https://github.com/example/example/publiccode.yml")

Thepubliccode-parser binary can be used to validate apubliccode.ymlfrom the command line.

To get the latest version use:

go install github.com/italia/publiccode-parser-go/v5/publiccode-parser@latest

Or get a precompiled package from therelease page

Example:

$ publiccode-parser mypubliccode.ymlpubliccode.yml:36:1: error: developmentStatus: developmentStatus must be one of the following:"concept","development","beta","stable" or"obsolete"publiccode.yml:48:3: warning: legal.authorsFile: This key is DEPRECATED and will be removedin the future. It's safe to drop itpubliccode.yml:12:5: warning: description.en.genericName: This key is DEPRECATED and will be removed in the future. It's safe to drop it

Runpubliccode-parser --help for the available command line flags.

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

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

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

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

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

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 thepubliccode.yml projectand itsCONTRIBUTING.mdguidelines.

• publiccode-parser-php - PHPbindings for this library
• publiccode-crawler - a Gocrawler that uses this library

This software is maintained by community contributors.

© 2018-present Team per la Trasformazione Digitale - Presidenza del Consigliodei Ministri

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