datapackage 0.1.3 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +140 -54
  3. data/bin/console +10 -0
  4. metadata +5 -52
  5. data/datapackage/schemas/LICENSE.md +0 -24
  6. data/datapackage/schemas/README.md +0 -33
  7. data/datapackage/schemas/csv-dialect-description-format.json +0 -30
  8. data/datapackage/schemas/data-package.json +0 -146
  9. data/datapackage/schemas/definitions.json +0 -222
  10. data/datapackage/schemas/fiscal-data-package.json +0 -279
  11. data/datapackage/schemas/fiscal-data-package.jsonld +0 -5
  12. data/datapackage/schemas/index.html +0 -15
  13. data/datapackage/schemas/json-table-schema.json +0 -83
  14. data/datapackage/schemas/registry.csv +0 -4
  15. data/datapackage/schemas/tabular-data-package.json +0 -147
  16. data/datapackage/schemas/tests/__init__.py +0 -0
  17. data/datapackage/schemas/tests/test_registry.py +0 -102
  18. data/datapackage/schemas/tests/test_schemas.py +0 -41
  19. data/lib/datapackage/exceptions.rb +0 -12
  20. data/lib/datapackage/package.rb +0 -181
  21. data/lib/datapackage/registry.rb +0 -81
  22. data/lib/datapackage/resource.rb +0 -83
  23. data/lib/datapackage/schema.rb +0 -111
  24. data/lib/datapackage/version.rb +0 -3
  25. data/lib/datapackage.rb +0 -17
data/datapackage/schemas/definitions.json DELETED
@@ -1,222 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-04/schema#",
3
- "define": {
4
- "schema": {
5
- "title": "Schema",
6
- "description": "The JSON Table Schema that describes of this resource.",
7
- "type": "object",
8
- "properties": {
9
- "fields": {
10
- "type": "array",
11
- "minItems": 0,
12
- "items": {
13
- "type": "object",
14
- "properties": {
15
- "name": {
16
- "type": "string",
17
- "propertyOrder": 10
18
- },
19
- "title": {
20
- "type": "string",
21
- "propertyOrder": 20
22
- },
23
- "description": {
24
- "type": "string",
25
- "propertyOrder": 30
26
- },
27
- "type": {
28
- "type": "string",
29
- "enum": [
30
- "string",
31
- "number",
32
- "integer",
33
- "boolean",
34
- "object",
35
- "array",
36
- "datetime",
37
- "date",
38
- "time",
39
- "duration",
40
- "geopoint",
41
- "geojson",
42
- "any"
43
- ],
44
- "propertyOrder": 40
45
- },
46
- "format": {
47
- "type": "string",
48
- "propertyOrder": 50
49
- }
50
- }
51
- }
52
- }
53
- }
54
- },
55
- "name": {
56
- "title": "Name",
57
- "description": "An identifier for this package. Lower case characters with '.', '_' and '-' are allowed.",
58
- "type": "string",
59
- "pattern": "^([a-z0-9._-])+$"
60
- },
61
- "title": {
62
- "title": "Title",
63
- "description": "A human-readable title.",
64
- "type": "string"
65
- },
66
- "description": {
67
- "title": "Description",
68
- "description": "A text description.",
69
- "type": "string"
70
- },
71
- "homepage": {
72
- "title": "Home Page",
73
- "description": "The URL for this data package's website.",
74
- "type": "string"
75
- },
76
- "version": {
77
- "title": "Version",
78
- "description": "A unique version number for this package.",
79
- "type": "string"
80
- },
81
- "url": {
82
- "title": "URL",
83
- "description": "The URL for this resource.",
84
- "type": "string"
85
- },
86
- "path": {
87
- "title": "Path",
88
- "description": "The relative path to this resource.",
89
- "type": "string"
90
- },
91
- "data": {
92
- "title": "Data",
93
- "description": "The inline data for this resource.",
94
- "anyOf": [
95
- { "type": "string" },
96
- { "type": "array" },
97
- { "type": "object" }
98
- ]
99
- },
100
- "format": {
101
- "title": "Format",
102
- "description": "The file format of this resource.",
103
- "type": "string"
104
- },
105
- "mediatype": {
106
- "title": "Media Type",
107
- "description": "The media type of this resource.",
108
- "type": "string",
109
- "pattern": "^(.+)/(.+)$"
110
- },
111
- "encoding": {
112
- "title": "Encoding",
113
- "description": "The file encoding of this resource.",
114
- "type": "string"
115
- },
116
- "bytes": {
117
- "title": "Bytes",
118
- "description": "The size of this resource in bytes.",
119
- "type": "integer"
120
- },
121
- "hash": {
122
- "title": "Hash",
123
- "type": "string",
124
- "description": "The MD5 hash of this resource. Indicate other hashing algorithms with the {algorithm}:{hash} format.",
125
- "pattern": "^([^:]+:[a-fA-F0-9]+|[a-fA-F0-9]{32}|)$"
126
- },
127
- "dialect": {
128
- "title": "Dialect",
129
- "description": "The dialect of this resource file type.",
130
- "type": "object"
131
- },
132
- "author": {
133
- "title": "Author",
134
- "description": "A contributor to this package.",
135
- "oneOf": [
136
- { "type": "string" },
137
- {
138
- "type": "object",
139
- "properties": {
140
- "name": { "type": "string" },
141
- "email": { "type": "string" },
142
- "web": { "type": "string" }
143
- },
144
- "required": [ "name" ]
145
- }
146
- ]
147
- },
148
- "contributors": {
149
- "title": "Contributors",
150
- "description": "The contributors to this package.",
151
- "type": "array",
152
- "items": {
153
- "$ref": "#/define/author"
154
- }
155
- },
156
- "license": {
157
- "title": "License",
158
- "description": "The license under which this package is published.",
159
- "oneOf": [
160
- { "type": "string" },
161
- {
162
- "type": "object",
163
- "properties": {
164
- "type": { "type": "string" },
165
- "url": { "type": "string" }
166
- },
167
- "anyOf": [
168
- { "title": "type required", "required": [ "type" ] },
169
- { "title": "url required", "required": [ "url" ] }
170
- ]
171
- }
172
- ]
173
- },
174
- "sources": {
175
- "title": "Sources",
176
- "description": "The raw sources for this resource.",
177
- "type": "array",
178
- "minItems": 0,
179
- "items": {
180
- "type": "object",
181
- "properties": {
182
- "name": { "type": "string" },
183
- "web": { "type": "string" },
184
- "email": { "type": "string" }
185
- },
186
- "anyOf": [
187
- { "title": "name required", "required": ["name"] },
188
- { "title": "web required", "required": ["web"] },
189
- { "title": "email required", "required": ["email"] }
190
- ]
191
- }
192
- },
193
- "keywords": {
194
- "title": "Keywords",
195
- "description": "A list of keywords that describe this package.",
196
- "type": "array",
197
- "items": { "type": "string" }
198
- },
199
- "image": {
200
- "title": "Image",
201
- "description": "A image to represent this package.",
202
- "type": "string"
203
- },
204
- "dataDependencies": {
205
- "title": "Data Dependencies",
206
- "description": "Additional Data Packages required to install this package.",
207
- "type": "object"
208
- },
209
- "countryCode": {
210
- "title": "ISO 3166-1 Alpha-2 Country code",
211
- "description": "A valid 2-digit ISO country code (ISO 3166-1 alpha-2), or, an array of valid ISO codes.",
212
- "oneOf": [
213
- { "type": "string", "pattern": "^[A-Z]{2}$" },
214
- {
215
- "type": "array",
216
- "minItems": 1,
217
- "items": { "type": "string", "pattern": "^[A-Z]{2}$" }
218
- }
219
- ]
220
- }
221
- }
222
- }
data/datapackage/schemas/fiscal-data-package.json DELETED
@@ -1,279 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-04/schema#",
3
- "title": "Fiscal Data Package",
4
- "description": "Fiscal Data Package is a simple specification for data access and delivery of fiscal data.",
5
- "type": "object",
6
- "required": [ "name", "title", "resources", "model" ],
7
- "properties": {
8
- "name": {
9
- "$ref": "definitions.json#/define/name",
10
- "propertyOrder": 10
11
- },
12
- "title": {
13
- "$ref": "definitions.json#/define/title",
14
- "propertyOrder": 20
15
- },
16
- "description": {
17
- "$ref": "definitions.json#/define/description",
18
- "format": "textarea",
19
- "propertyOrder": 30
20
- },
21
- "homepage": {
22
- "$ref": "definitions.json#/define/homepage",
23
- "propertyOrder": 40
24
- },
25
- "version": {
26
- "$ref": "definitions.json#/define/version",
27
- "propertyOrder": 50
28
- },
29
- "license": {
30
- "$ref": "definitions.json#/define/license",
31
- "propertyOrder": 60
32
- },
33
- "author": {
34
- "$ref": "definitions.json#/define/author",
35
- "propertyOrder": 70
36
- },
37
- "contributors": {
38
- "$ref": "definitions.json#/define/contributors",
39
- "propertyOrder": 80,
40
- "options": { "hidden": true }
41
- },
42
- "resources": {
43
- "title": "Resources",
44
- "description": "The data resources that this package describes.",
45
- "type": "array",
46
- "propertyOrder": 90,
47
- "minItems": 0,
48
- "items": {
49
- "type": "object",
50
- "properties": {
51
- "name": {
52
- "$ref": "definitions.json#/define/name",
53
- "propertyOrder": 10
54
- },
55
- "title": {
56
- "$ref": "definitions.json#/define/title",
57
- "propertyOrder": 20
58
- },
59
- "description": {
60
- "$ref": "definitions.json#/define/description",
61
- "propertyOrder": 30,
62
- "format": "textarea"
63
- },
64
- "schema": {
65
- "$ref": "definitions.json#/define/schema",
66
- "propertyOrder": 40
67
- },
68
- "url": {
69
- "$ref": "definitions.json#/define/url",
70
- "propertyOrder": 50
71
- },
72
- "path": {
73
- "$ref": "definitions.json#/define/path",
74
- "propertyOrder": 60
75
- },
76
- "data": {
77
- "$ref": "definitions.json#/define/data",
78
- "propertyOrder": 70
79
- },
80
- "format": {
81
- "$ref": "definitions.json#/define/format",
82
- "propertyOrder": 80
83
- },
84
- "mediatype": {
85
- "$ref": "definitions.json#/define/mediatype",
86
- "propertyOrder": 90
87
- },
88
- "encoding": {
89
- "$ref": "definitions.json#/define/encoding",
90
- "propertyOrder": 100
91
- },
92
- "bytes": {
93
- "$ref": "definitions.json#/define/bytes",
94
- "propertyOrder": 110,
95
- "options": { "hidden": true }
96
- },
97
- "hash": {
98
- "$ref": "definitions.json#/define/hash",
99
- "propertyOrder": 120,
100
- "options": { "hidden": true }
101
- },
102
- "dialect": {
103
- "$ref": "definitions.json#/define/dialect",
104
- "propertyOrder": 130,
105
- "options": { "hidden": true }
106
- },
107
- "sources": {
108
- "$ref": "definitions.json#/define/sources",
109
- "propertyOrder": 140,
110
- "options": { "hidden": true }
111
- },
112
- "license": {
113
- "$ref": "definitions.json#/define/license",
114
- "description": "The license under which the resource is published.",
115
- "propertyOrder": 150,
116
- "options": { "hidden": true }
117
- }
118
- },
119
- "anyOf": [
120
- { "title": "url required", "required": ["url"] },
121
- { "title": "path required", "required": ["path"] },
122
- { "title": "data required", "required": ["data"] }
123
- ]
124
- }
125
- },
126
- "keywords": {
127
- "$ref": "definitions.json#/define/keywords",
128
- "propertyOrder": 100
129
- },
130
- "sources": {
131
- "$ref": "definitions.json#/define/sources",
132
- "propertyOrder": 110,
133
- "options": { "hidden": true }
134
- },
135
- "image": {
136
- "$ref": "definitions.json#/define/image",
137
- "propertyOrder": 120,
138
- "options": { "hidden": true }
139
- },
140
- "base": {
141
- "$ref": "definitions.json#/define/base",
142
- "propertyOrder": 130,
143
- "options": { "hidden": true }
144
- },
145
- "dataDependencies": {
146
- "$ref": "definitions.json#/define/dataDependencies",
147
- "propertyOrder": 140,
148
- "options": { "hidden": true }
149
- },
150
- "countryCode": { "$ref": "definitions.json#/define/countryCode" },
151
- "granularity": {
152
- "title": "Granularity of resources",
153
- "description": "A keyword that represents the type of spend data, eiter aggregated or transactional",
154
- "type": "string",
155
- "enum": ["aggregated", "transactional"]
156
- },
157
- "fiscalPeriod": {
158
- "title": "Fiscal period for the budget",
159
- "description": "The fiscal period of the dataset",
160
- "type": "object",
161
- "properties": {
162
- "start": {
163
- "type": "string",
164
- "pattern": "^\\d{4}-(0?[1-9]|1[012])-(0?[1-9]|[12]\\d|3[01])"
165
- },
166
- "end": {
167
- "type": "string",
168
- "pattern": "^\\d{4}-(0?[1-9]|1[012])-(0?[1-9]|[12]\\d|3[01])"
169
- }
170
- },
171
- "required": ["start"]
172
- },
173
- "model": {
174
- "title": "Model",
175
- "description": "The 'logical model' for the data",
176
- "type": "object",
177
- "properties": {
178
- "measures": {
179
- "title": "Measures",
180
- "description": "Measures are numerical and correspond to financial amounts in the source data.",
181
- "type": "object",
182
- "patternProperties": {
183
- "^\\w+": {
184
- "type": "object",
185
- "properties": {
186
- "source": { "type": "string" },
187
- "resource": { "type": "string" },
188
- "currency": { "type": "string", "pattern": "^[A-Z]{3}$" },
189
- "factor": { "type": "number" },
190
- "direction": {
191
- "title": "Direction of the spending",
192
- "description": "A keyword that represents the direction of the spend, either expenditure or revenue.",
193
- "type": "string",
194
- "enum": [ "expenditure", "revenue" ]
195
- },
196
- "phase": {
197
- "title": "Budget phase",
198
- "description": "A keyword that represents the phase of the data, can be proposed for a budget proposal, approved for an approved budget, adjusted for modified budget or executed for the enacted budget",
199
- "type": "string",
200
- "enum": ["proposed", "approved", "adjusted", "executed"]
201
- }
202
- },
203
- "required": [ "source", "currency" ]
204
- }
205
- }
206
- },
207
- "dimensions": {
208
- "title": "Dimensions",
209
- "description": "Dimensions are groups of related fields. Dimensions cover all items other than the measure.",
210
- "type": "object",
211
- "patternProperties": {
212
- "^\\w+": {
213
- "type": "object",
214
- "properties": {
215
- "attributes": {
216
- "title": "Attributes",
217
- "description": "Attribute objects that make up the dimension",
218
- "type": "object",
219
- "minItems": 1,
220
- "patternProperties": {
221
- "^\\w+": {
222
- "type": "object",
223
- "properties": {
224
- "source": { "type": "string" },
225
- "resource": { "type": "string" },
226
- "constant": {
227
- "oneOf": [
228
- { "type": "string" },
229
- { "type": "number" }
230
- ]
231
- },
232
- "parent": { "type": "string" },
233
- "labelfor": { "type": "string" }
234
- },
235
- "required": [ "source" ]
236
- }
237
- }
238
- },
239
- "primaryKey": {
240
- "title": "Primary Key",
241
- "description": "Either an array of strings corresponding to the name attributes in a set of field objects in the fields array or a single string corresponding to one of these names. The value of primaryKey indicates the primary key or primary keys for the dimension.",
242
- "oneOf": [
243
- { "type": "string" },
244
- {
245
- "type": "array",
246
- "minItems": 1,
247
- "items": { "type": "string" }
248
- }
249
- ]
250
- },
251
- "dimensionType": {
252
- "title": "Dimension Type",
253
- "description": "Describes what kind of a dimension it is.",
254
- "type": "string",
255
- "enum": [
256
- "datetime",
257
- "entity",
258
- "classification",
259
- "activity",
260
- "fact",
261
- "location",
262
- "other"
263
- ]
264
- },
265
- "classificationType": {
266
- "title": "Classification Type",
267
- "description": "The type of the classification.",
268
- "enum": [ "functional", "administrative", "economic" ]
269
- }
270
- },
271
- "required": [ "attributes", "primaryKey" ]
272
- }
273
- }
274
- }
275
- },
276
- "required": [ "measures", "dimensions" ]
277
- }
278
- }
279
- }
data/datapackage/schemas/fiscal-data-package.jsonld DELETED
@@ -1,5 +0,0 @@
1
- {
2
- "@context": {
3
- "@vocab": "http://schemas.frictionlessdata.io/fiscal-data-package#"
4
- }
5
- }
data/datapackage/schemas/index.html DELETED
@@ -1,15 +0,0 @@
1
- <!doctype>
2
- <html>
3
- <head>
4
- <meta charset='utf-8' />
5
- <base href='/' />
6
- <meta httpEquiv='x-ua-compatible' content='ie=edge' />
7
- <meta name='description' content='JSON Schemas, and a registry, for the Data Package family of specifications.' />
8
- <meta name='viewport' content='width=device-width, initial-scale=1' />
9
- <title>Data Package Schemas | Open Knowledge</title>
10
- </head>
11
- <body>
12
- <h1>Data Package Schemas</h1>
13
- <p>See the <a href="/registry.csv">registry</a>.</p>
14
- </body>
15
- </html>
data/datapackage/schemas/json-table-schema.json DELETED
@@ -1,83 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-04/schema#",
3
- "title": "JSON Table Schema",
4
- "description": "JSON Table Schema is a specification for describing tabular data.",
5
- "type": "object",
6
- "properties": {
7
- "fields": {
8
- "type": "array",
9
- "minItems": 1,
10
- "items": {
11
- "type": "object",
12
- "properties": {
13
- "name": { "type": "string" },
14
- "title": { "type": "string" },
15
- "description": { "type": "string" },
16
- "type": {
17
- "enum": [
18
- "string",
19
- "number",
20
- "integer",
21
- "date",
22
- "time",
23
- "datetime",
24
- "boolean",
25
- "object",
26
- "geopoint",
27
- "geojson",
28
- "array",
29
- "duration",
30
- "any"
31
- ]
32
- },
33
- "rdfType": {"type": "string" },
34
- "format": { "type": "string" },
35
- "constraints": {
36
- "type": "object",
37
- "properties": {
38
- "required": { "type": "boolean" },
39
- "minLength": { "type": "integer" },
40
- "maxLength": { "type": "integer" },
41
- "unique": { "type": "boolean" },
42
- "pattern": { "type": "string" },
43
- "minimum": {
44
- "oneOf": [ { "type": "string" }, { "type": "number" } ]
45
- },
46
- "maximum": {
47
- "oneOf": [ {"type": "string"}, {"type": "number"} ]
48
- },
49
- "enum": {
50
- "type": "array",
51
- "minItems": 1,
52
- "uniqueItems": true
53
- }
54
- }
55
- }
56
- },
57
- "required": ["name"]
58
- }
59
- },
60
- "primaryKey": {
61
- "oneOf": [ { "type": "string" }, { "type": "array" } ]
62
- },
63
- "foreignKeys": {
64
- "type": "array",
65
- "items": {
66
- "type": "object",
67
- "required": [ "fields", "reference" ],
68
- "properties": {
69
- "fields": { "oneOf": [ { "type": "string" }, { "type": "array" } ] },
70
- "reference": {
71
- "type": "object",
72
- "required": [ "resource", "fields" ],
73
- "properties": {
74
- "resource": { "type": "string" },
75
- "fields": { "oneOf": [ { "type": "string" }, { "type": "array" } ] }
76
- }
77
- }
78
- }
79
- }
80
- }
81
- },
82
- "required": [ "fields" ]
83
- }
data/datapackage/schemas/registry.csv DELETED
@@ -1,4 +0,0 @@
1
- id,title,schema,schema_path,specification
2
- base,Data Package,http://schemas.datapackages.org/data-package.json,data-package.json,http://dataprotocols.org/data-packages
3
- tabular,Tabular Data Package,http://schemas.datapackages.org/tabular-data-package.json,tabular-data-package.json,http://dataprotocols.org/tabular-data-package/
4
- fiscal,Fiscal Data Package,http://schemas.datapackages.org/fiscal-data-package.json,fiscal-data-package.json,http://fiscal.dataprotocols.org/spec/