publiccode-validator

README

publiccode.yml web validator for Go

This is a Go, web interface validator for publiccode.yml files, using publiccode-parser-go.

publiccode.yml is an international standard for describing public software. It is expected to be published in the root of open source repositories. This parser performs syntactic and semantic validation according to the official spec.

Features

See related project for details: publiccode-parser-go

Validation from command line

The repository also contains a tool used to validate publiccode.yml files locally.

go run src/main.go

curl -XPOST localhost:5000/pc/validate -d '{
  "localisation": {
    "localisationReady": false
  },
  "description": {
    "it": {
      "shortDescription": "test"
    }
  },
  "publiccodeYmlVersion": "0.2"
}'

Docker support

The repository has a Dockerfile, used to also build the production image, and a docker-compose.yml file to facilitate the local deployment.

To build the container, run:

docker-compose up [-d] [--build]

where:

• -d execute the containers in background

• --build forces the containers build

To destroy the container, use:

docker-compose down

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 for PC.
• publiccode-parser-go - a Go parser and validator for publiccode.yml files.

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.