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.

Minimum Version

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

Extended Version

  1publiccodeYmlVersion: "0"
  2
  3name: Medusa
  4applicationSuite: MegaProductivitySuite
  5url: "https://example.com/italia/medusa.git"
  6landingURL: "https://example.com/italia/medusa"
  7isBasedOn:
  8  - "https://github.com/italia/otello.git"
  9softwareVersion: "1.0"
 10releaseDate: "2017-04-15"
 11logo: img/logo.svg
 12
 13platforms:
 14  - android
 15  - ios
 16
 17categories:
 18  - content-management
 19  - office
 20
 21usedBy:
 22  - Comune di Firenze
 23  - Comune di Roma
 24
 25roadmap: "https://example.com/italia/medusa/roadmap"
 26
 27developmentStatus: development
 28
 29softwareType: "standalone/desktop"
 30
 31intendedAudience:
 32  scope:
 33    - science-and-technology
 34  countries:
 35    - IT
 36    - DE
 37
 38description:
 39  en:
 40    localisedName: Medusa
 41    shortDescription: >
 42      This description can have a maximum 150
 43      characters long. We should not fill the
 44      remaining space with "Lorem Ipsum". End
 45
 46    longDescription: >
 47      Very long description of this software, also split
 48      on multiple rows. You should note what the software
 49      is and why one should need it.
 50      It can also contain some basic Markdown.
 51
 52    documentation: "https://read.the.documentation/medusa/v1.0"
 53    apiDocumentation: "https://read.the.api.doc/medusa/v1.0"
 54
 55    features:
 56      - Very important feature
 57      - Will run without a problem
 58      - Has zero bugs
 59      - Solves all the problems of the world
 60    screenshots:
 61      - img/sshot1.jpg
 62      - img/sshot2.jpg
 63      - img/sshot3.jpg
 64    awards:
 65      - 1st Price Software of the year
 66
 67legal:
 68  license: AGPL-3.0-or-later
 69  mainCopyrightOwner: City of Chicago
 70
 71maintenance:
 72  type: "contract"
 73
 74  contractors:
 75    - name: "Fornitore Privato SPA"
 76      email: "dario.bianchi@fornitore.it"
 77      website: "https://privatecompany.com"
 78      until: "2019-01-01"
 79
 80  contacts:
 81    - name: Francesco Rossi
 82      email: "francesco.rossi@comune.reggioemilia.it"
 83      affiliation: Comune di Reggio Emilia
 84      phone: "+3923113215112"
 85
 86localisation:
 87  localisationReady: true
 88  availableLanguages:
 89    - en
 90    - it
 91    - fr
 92    - de
 93
 94dependsOn:
 95  proprietary:
 96    - name: Oracle
 97      versionMin: "11.4"
 98    - name: IBM SoftLayer
 99  hardware:
100    - name: NFC Reader
101      optional: true
102
103organisation:
104  uri: urn:x-italian-pa:c_h501
105  name: Roma Capitale