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

6.2. Extended Version

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