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