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
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
6.2. Extended Version¶
1publiccodeYmlVersion: "0"
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
74maintenance:
75 type: "contract"
76
77 contractors:
78 - name: "Fornitore Privato SPA"
79 email: "dario.bianchi@fornitore.it"
80 website: "https://privatecompany.com"
81 until: "2019-01-01"
82
83 contacts:
84 - name: Francesco Rossi
85 email: "francesco.rossi@comune.reggioemilia.it"
86 affiliation: Comune di Reggio Emilia
87 phone: "+3923113215112"
88
89localisation:
90 localisationReady: true
91 availableLanguages:
92 - en
93 - it
94 - fr
95 - de
96
97dependsOn:
98 open:
99 - name: MySQL
100 versionMin: "1.1"
101 versionMax: "1.3"
102 optional: true
103 - name: PostgreSQL
104 version: "3.2"
105 optional: true
106 proprietary:
107 - name: Oracle
108 versionMin: "11.4"
109 - name: IBM SoftLayer
110 hardware:
111 - name: NFC Reader
112 optional: true
113
114IT:
115 countryExtensionVersion: "1.0"
116
117 piattaforme:
118 spid: true
119 cie: true
120 anpr: true
121 pagopa: true
122
123organisation:
124 uri: urn:x-italian-pa:c_h501
125 name: Roma Capitale