aboutsummaryrefslogtreecommitdiff
path: root/CHANGELOG.md
blob: fef780190dd64b77d7f0072779e87be6f9c2cf3f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
## v1.1.7

* Updated `repr()` for `Master` object to account for it relating to a
  month or a quarter.

## v1.1.6

* Added the `Month()` object to `datamaps.api`. You can now assign a month
  to a `Master()` object using the function
  `datamaps.api.project_data_from_master_month`.

## v1.1.5

* Additional version bump to bring into line with `bcompiler-engine`.

## v1.1.4

* Fixed zip bug in `bcompiler-engine`, which is bumped to `v1.1.4`
(https://github.com/yulqen/datamaps/issues/18).
* Additional version bump to bring into line with `bcompiler-engine`.

## v1.1.2

* Introduced the `-z/--zipinput` flag to `datamaps import templates` command,
    allowing user to point to a zip file containing populated templates.

## v1.1.1

* fixed bug where relative paths could not be used as CLI flags.

## v1.1.0

The first major feature release to `datamaps`.

### Simple data validation

The user is now able to stipulate the type of data expected to be
returned per cell during the `import templates` phase. Allowable types at this
stage are simply `TEXT`, `NUMBER` and `DATE`.

The types are declared in the datamap in a new column headed 'type'. Upon
import, datamaps will validate the value of the data in that particular cell
according to the required type and output the results in a CSV file in the
default output directory.

Type-validation is entirely optional: if no type column is included in the
datamap file, no validation is carried out. If a type column *is* included and
only a handful of datamap entries have types declared, a validation report is
produced, but only those cells are assessed - the rest are declared as UNTYPED.

Empty cells in the template that are expected by the datamap are flagged in the
validation report. The logic here is that if the cell is in the datamap in the
first place, we should expect a value returned.

If the user only requires validation for a single template or batch of
templates - and no master.xlsx to be produced - this can now be set using the
`-v` flag:

`datamaps import templates -v`. Please not that the `-m` and `-v` flags are
mutually exclusive.

The validation report is in CSV format to allow for rudimentary sorting and
filtering in a spreadsheet program.

This is the first iteration of validation in datamaps - more sophisticated
validation is planned for future releases, with rules-based types such as 
greater-than and less-than for numbers, date ranges and text minimum and maximum 
lengths in the frame.

### Change to setting the row limit

The row limiting feature released in `v1.0.7` must now be set using
a `--rowlimit` option to `datamaps import templates` and there is no longer any
need to change the `config.ini` file.  The default row limit remains 500.

### Configurable input directory

The input directory can now be overridden using the `--inputdir` option to
`datamaps import templates`. In future releases, it may be possible to override
the output directory also.

### Help documentation

The `--help` documentation has been improved across the board.

### Bugfixes

Some minor bugfixes introduced in recent releases.


## v1.0.9

* Bug fixes.

## v1.0.8

* Now handles `datamaps config` commands. The `config.ini` can be revealed to
  the user and deleted.

## v1.0.7

* Added a row limit in `bcompiler-engine` when importing data to prevent memory leak ([Issue #30](https://github.com/yulqen/bcompiler-engine/issues/30))

## v1.0.6

* Tracking changes in `bcompiler-engine v.1.0.6`

## v1.0.0b13

* New **check** command

### Example:

```
datamaps check
```

Checks that the necessary auxiliary files are in place so that basic
functionality can take place.

Checks for:

* Documents/input/blank_template.xlsx
* Documents/input/datamap.csv

Also carries out basic sanity checks on the datamap file, to ensure requisite
headers, number of fields, etc.