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    shortDescription: >
21          A rather short description which
22          is probably useless
23
24    longDescription: >
25          Very long description of this software, also split
26          on multiple rows. You should note what the software
27          is and why one should need it. We can potentially
28          have many pages of text here.
29
30    features:
31       - Just one feature
32
33legal:
34  license: AGPL-3.0-or-later
35
36maintenance:
37  type: "community"
38
39  contacts:
40    - name: Francesco Rossi
41
42localisation:
43  localisationReady: true
44  availableLanguages:
45    - en

6.2. Extended Version

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