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