6. Examples

Below there are two examples of publiccode.yml files, the first one represents the minimum configuration, which contains the mandatory fields, whilst the second one represents a more extended version.

6.1. Minimum Version

 1publiccodeYmlVersion: "0.2"
 2
 3name: Medusa
 4url: "https://example.com/italia/medusa.git"
 5softwareVersion: "dev"    # Optional
 6releaseDate: "2017-04-15"
 7platforms:
 8  - web
 9
10categories:
11  - financial-reporting
12
13developmentStatus: development
14
15softwareType: "standalone/desktop"
16
17description:
18  en:
19    localisedName: medusa   # Optional
20    genericName: Text Editor
21    shortDescription: >
22          A rather short description which
23          is probably useless
24
25    longDescription: >
26          Very long description of this software, also split
27          on multiple rows. You should note what the software
28          is and why one should need it. We can potentially
29          have many pages of text here.
30
31    features:
32       - Just one feature
33
34legal:
35  license: AGPL-3.0-or-later
36
37maintenance:
38  type: "community"
39
40  contacts:
41    - name: Francesco Rossi
42
43localisation:
44  localisationReady: yes
45  availableLanguages:
46    - en

6.2. Extended Version

  1publiccodeYmlVersion: "0.2"
  2
  3name: Medusa
  4applicationSuite: MegaProductivitySuite
  5url: "https://example.com/italia/medusa.git"
  6landingURL: "https://example.com/italia/medusa"
  7isBasedOn: "https://github.com/italia/otello.git"
  8softwareVersion: "1.0"
  9releaseDate: "2017-04-15"
 10logo: img/logo.svg
 11monochromeLogo: img/logo-mono.svg
 12
 13inputTypes:
 14  - text/plain
 15outputTypes:
 16  - text/plain
 17
 18platforms:
 19  - android
 20  - ios
 21
 22categories:
 23  - content-management
 24  - office
 25
 26usedBy:
 27  - Comune di Firenze
 28  - Comune di Roma
 29
 30roadmap: "https://example.com/italia/medusa/roadmap"
 31
 32developmentStatus: development
 33
 34softwareType: "standalone/desktop"
 35
 36intendedAudience:
 37  scope:
 38    - science-and-technology
 39  countries:
 40    - it
 41    - de
 42  unsupportedCountries:
 43    - us
 44
 45description:
 46  en:
 47    localisedName: Medusa
 48    genericName: Text Editor
 49    shortDescription: >
 50          This description can have a maximum 150
 51          characters long. We should not fill the
 52          remaining space with "Lorem Ipsum". End
 53
 54    longDescription: >
 55          Very long description of this software, also split
 56          on multiple rows. You should note what the software
 57          is and why one should need it.
 58
 59    documentation: "https://read.the.documentation/medusa/v1.0"
 60    apiDocumentation: "https://read.the.api.doc/medusa/v1.0"
 61
 62    features:
 63       - Very important feature
 64       - Will run without a problem
 65       - Has zero bugs
 66       - Solves all the problems of the world
 67    screenshots:
 68       - img/sshot1.jpg
 69       - img/sshot2.jpg
 70       - img/sshot3.jpg
 71    videos:
 72       - https://youtube.com/xxxxxxxx
 73    awards:
 74       - 1st Price Software of the year
 75
 76legal:
 77  license: AGPL-3.0-or-later
 78  mainCopyrightOwner: City of Chicago
 79  repoOwner: City of Chicago
 80  authorsFile: AUTHORS
 81
 82maintenance:
 83  type: "contract"
 84
 85  contractors:
 86    - name: "Fornitore Privato SPA"
 87      email: "dario.bianchi@fornitore.it"
 88      website: "https://privatecompany.com"
 89      until: "2019-01-01"
 90
 91  contacts:
 92    - name: Francesco Rossi
 93      email: "francesco.rossi@comune.reggioemilia.it"
 94      affiliation: Comune di Reggio Emilia
 95      phone: "+3923113215112"
 96
 97localisation:
 98  localisationReady: yes
 99  availableLanguages:
100    - en
101    - it
102    - fr
103    - de
104
105dependsOn:
106  open:
107    - name: MySQL
108      versionMin: "1.1"
109      versionMax: "1.3"
110      optional: yes
111    - name: PostgreSQL
112      version: "3.2"
113      optional: yes
114  proprietary:
115    - name: Oracle
116      versionMin: "11.4"
117    - name: IBM SoftLayer
118  hardware:
119    - name: NFC Reader
120      optional: yes
121
122it:
123  countryExtensionVersion: "0.2"
124
125  conforme:
126    lineeGuidaDesign: yes
127    modelloInteroperabilita: yes
128    misureMinimeSicurezza: yes
129    gdpr: yes
130
131  piattaforme:
132    spid: yes
133    cie: yes
134    anpr: yes
135    pagopa: yes
136
137  riuso:
138    codiceIPA: c_h501