Skip to content

Commit b9e2e1f

Browse files
authored
doc: add tooling section to README (#295)
Document the available tools and libraries around the specification. See #275 (comment)
1 parent 09d4190 commit b9e2e1f

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,66 @@ uv run sphinx-build docs/standard build -c .
132132
then open the relevant file in the build directory with a browser (e.g.,
133133
`build/index.html`) to explore the contents.
134134

135+
### Tooling
136+
137+
Tools and libraries that implement and support the publiccode.yml Standard.
138+
139+
#### Core tools
140+
141+
Core tools are developed alongside the publiccode.yml specification and provide
142+
its reference implementations and supporting components.
143+
144+
- **[publiccode-parser-go](https://github.com/italia/publiccode-parser-go)**
145+
146+
Go parser and validator. Reference implementation of the specification.
147+
148+
- **[publiccode-parser-php](https://github.com/bfabio/publiccode-parser-php)**
149+
150+
PHP library for parsing and validation using the reference implementation via FFI.
151+
152+
- **[publiccode-crawler](https://github.com/italia/publiccode-crawler)**
153+
154+
Crawler to discover and collect descriptor files for catalogs.
155+
156+
- **[software-catalog-api](https://github.com/italia/developers-italia-api)**
157+
158+
RESTful API powering software catalogs for public administrations, used to
159+
store, query and expose all catalog data about FLOSS solutions.
160+
161+
- **[publiccode-api-client](https://github.com/bfabio/publiccode-api-client)**
162+
163+
Convenience command-line client to query the catalog API. (*alpha*)
164+
165+
- **[publiccode-parser-action](https://github.com/italia/publiccode-parser-action)**
166+
167+
GitHub Action for validation in GitHub pipelines.
168+
169+
- **[publiccode-parser-gitlab-ci](https://github.com/italia/publiccode-parser-gitlab-ci)**
170+
171+
GitLab CI integration for validation
172+
173+
- **[publiccode-validator-api](https://github.com/italia/publiccode-validator-api)**
174+
175+
Simple RESTful API for validating publiccode.yml files, returning errors and warnings.
176+
177+
- **[JSON SChema on SchemaStore](https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/publiccode.json)**
178+
179+
JSON Schema definition mainly used by editors and IDEs for coarse validation
180+
and autocompletion.
181+
182+
#### Third-party tooling
183+
184+
Maintained separately from the core tooling, but widely used in practice.
185+
186+
- **[publiccode-editor](https://github.com/italia/publiccode-editor)**
187+
188+
User friendly editor and basic validator for publiccode.yml files (maintained
189+
by Developers Italia, Italian Government).
190+
191+
- **[publiccode-parser-orb](https://github.com/italia/publiccode-parser-orb)**
192+
193+
CircleCI Orb for validation in pipelines.
194+
135195
## License
136196

137197
Licensed under the [CC0-1.0](LICENSE).

0 commit comments

Comments
 (0)