Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/italia/publiccode-parser-go
publiccode.yml parser library and validator in Go
https://github.com/italia/publiccode-parser-go
golang golang-library hacktoberfest parser publiccode publiccodeyml validator yaml
Last synced: 4 months ago
JSON representation
publiccode.yml parser library and validator in Go
- Host: GitHub
- URL: https://github.com/italia/publiccode-parser-go
- Owner: italia
- License: eupl-1.2
- Created: 2018-03-21T15:38:11.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-28T08:21:52.000Z (4 months ago)
- Last Synced: 2024-09-28T10:03:10.185Z (4 months ago)
- Topics: golang, golang-library, hacktoberfest, parser, publiccode, publiccodeyml, validator, yaml
- Language: Go
- Homepage:
- Size: 9.39 MB
- Stars: 15
- Watchers: 13
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
- .github - publiccode-parser-go
README
# publiccode.yml parser for Go
[](https://developersitalia.slack.com/messages/CAM3F785T)
[](https://slack.developers.italia.it/)
A Go parser and validator for [publiccode.yml](https://github.com/publiccodeyml/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](https://yml.publiccode.tools).
## Features
- Go library and CLI tool (`publiccode-parser`)
- Supports the latest version of the `publiccode.yml` Standard
- `publiccode-parser` can output validation errors as JSON or in [errorformat](https://vim-jp.org/vimdoc-en/quickfix.html#error-file-format) friendly way
- Verifies the existence of URLs by checking the response for URL fields (can be disabled)
## Example usage as a library
```go
parser, err := publiccode.NewDefaultParser()
// error handling
publiccode, err := parser.Parse("file:///path/to/local/dir/publiccode.yml")
// OR
// parse.Parse("https://github.com/example/example/publiccode.yml")
```
## Validation from command line
The `publiccode-parser` binary which be used for validating a `publiccode.yml`
from the command line.
To get the latest development version use:
```shell
go install github.com/italia/publiccode-parser-go/v4/publiccode-parser@latest
publiccode-parser mypubliccode.yml
```
To get the latest stable version go to the [release page](https://github.com/italia/publiccode-parser-go/releases/latest)
and grab the one for your arch.
Run `publiccode-parser --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:
```shell
docker run -i italia/publiccode-parser-go /dev/stdin < publiccode.yml
```
The image is available on [Dockerhub](https://hub.docker.com/repository/docker/italia/publiccode-parser-go).
You can also build your own running:
```sh
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
```shell
docker run -i italia/publiccode-parser-go -export /dev/stdout /dev/stdin < publiccode.yml
```
- Validate a publiccode file named `publiccode.yml` in `/home/user`
```shell
docker run -v /home/user:/go/src/files italia/publiccode-parser-go
```
- Validate a publiccode file named `/opt/publiccodes/my-amazing-code.yaml`
```shell
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)
```shell
docker run -v /opt/publiccodes/publiccodes:/files italia/publiccode-parser-go -no-network publiccode.yml
```
- Debugging, access the container interactive shell, overriding the entrypoint
```shell
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](CONTRIBUTING.md).
In order to support other country-specific extensions in addition to Italy some
refactoring might be needed.
## See also
* [publiccode-crawler](https://github.com/italia/publiccode-crawler) - a Go crawler that uses this library
## Maintainers
This software is maintained by the
[Developers Italia](https://developers.italia.it/) team.
## License
© 2018-present Team per la Trasformazione Digitale - Presidenza del Consiglio dei Ministri
Licensed under the EUPL 1.2.
The version control system provides attribution for specific lines of code.