CHANGELOG.md 17 KB
Newer Older
1
<!--
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
hifis-surveyval
Framework to help developing analysis scripts for the HIFIS Software survey.

SPDX-FileCopyrightText: 2021 HIFIS Software <support@hifis.net>

SPDX-License-Identifier: GPL-3.0-or-later

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
21
22
23
24
25
26
27
28
29
30
31
32
33
-->

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

Group your changes into these categories:

`Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`.

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
## [1.2.0](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/releases/v1.2.0) - 2021-10-07

[List of commits](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/compare/v1.2.0-preview...v1.2.0)

### Fixed
- Reorder steps to now manipulate IDs from CSV data header in the correct order
  ([!139](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/139)
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).

### Changed
- Use accessors for properties like text and label in example script 1 - accessing data
  ([!140](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/140)
  by [hueser93](https://gitlab.hzdr.de/hueser93))
- Add Unix swap files to file .gitignore
  ([!136](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/136)
  by [tfoerst1](https://gitlab.hzdr.de/tfoerst1)).
- Adapt file README.md to cover new configuration variables in configuration file
  ([!141](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/141)
  by [hueser93](https://gitlab.hzdr.de/hueser93)).

### Added
- Raise exception if _group-by_-argument passed to grouping function contains NaN values
  ([!143](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/143)
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Make aspect ratio of plots customizable and add auto-sizing to plotting methods
  ([!142](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/142)
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Add mixins to offer accessors for model properties and make HIERARCHY_SEPARATOR configurable
  ([!131](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/131)
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).

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
## [1.2.0-preview](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/releases/v1.2.0-preview) - 2021-10-01

[List of commits](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/compare/v1.1.1...v1.2.0-preview)

### Fixed
- Various minor quality fixes: adapt file .gitignore and fix typos
  ([!125](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/125)
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
- Project and repository URL changed and need to be adapted in the documentation
  ([!126](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/126)
  by [hueser93](https://gitlab.hzdr.de/hueser93))
- Automate rewriting of the CSV data file header if Question Collection full IDs are missing the Question ID part
  ([!124](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/124)
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
- Fixing that invalid answers are removed multiple times which results in key errors
  ([!129](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/129)
  by [hueser93](https://gitlab.hzdr.de/hueser93))
- Fixing that answer values are all transformed to True if casted to bool when read in from data
  ([!127](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/127)
  by [hueser93](https://gitlab.hzdr.de/hueser93))
- Fixing example analysis script about accessing data and use ANONYMOUS_QUESTION_ID where necessary
  ([!135](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/135)
  by [hueser93](https://gitlab.hzdr.de/hueser93))
- Replace _ (underscore) with / (slash) as HIERARCHY_SEPARATOR given in data header when reading in data
  ([!134](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/134)
  by [hueser93](https://gitlab.hzdr.de/hueser93))

### Added
- Develop example analysis script with step-by-step explanations to access metadata and data
  ([!128](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/128)
  by [hueser93](https://gitlab.hzdr.de/hueser93))
- Split metadata YAML file up into one file per question collection
  ([!122](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/122)
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).

100
## [1.1.1](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/releases/v1.1.1) - 2021-08-10
101

102
[List of commits](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/compare/v1.1.0...v1.1.1)
103
104
105

### Fixed
- Adapt schema that validates IETF language tags in metadata file
106
  ([!112](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/112)
107
108
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
- Improve error handling in a couple of locations
109
  ([!114](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/114)
110
111
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
- Add encoding when processing files
112
  ([!111](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/111)
113
114
  by [KatDwo](https://gitlab.hzdr.de/KatDwo)).
- Fix issue with method that concatenates data-frames
115
  ([!116](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/116)
116
117
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Move preprocessing example script into separate file
118
  ([!117](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/117)
119
120
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Adapt file README to describe how to quick-start the project and the content of the configuration file
121
  ([!118](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/118)
122
123
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Make sure that input data is rejected if it is not CSV
124
  ([!115](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/115)
125
126
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
- Method constructing a series from a given question ID should set the name of the index column
127
  ([!103](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/103)
128
129
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Refactor unit test cases to remove duplications and redundancies
130
  ([!120](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/120)
131
132
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Implement a helper class to create series or data-frame objects in unit test cases
133
  ([!121](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/121)
134
135
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Write unit test cases for module question that test the conversion of a question into a series
136
  ([!105](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/105)
137
138
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Write unit test cases for module question_collection that test the conversion of a question_collection into a data-frame
139
  ([!119](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/119)
140
141
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Write unit test cases for module data_container that test conversion of IDs of question_collections into a data-frame
142
  ([!104](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/104)
143
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
144

145
## [1.1.0](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/releases/v1.1.0) - 2021-07-13
146

147
[List of commits](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/compare/v1.0.1...v1.1.0)
148

149
150
### Added
- Additional features for preprocessing to mark and filter out specific answers
151
  ([!106](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/106)
152
153
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
- Enable DataContainer to compose a DataFrame from given IDs
154
  ([!100](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/100)
155
156
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
- Add license files for issue templates
157
  ([!109](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/109)
158
159
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
- Write a section in CONTRIBUTING file about how to create and document a tag
160
  ([!102](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/102)
161
162
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
  
163
### Changed
164
- Exclude release links from link checking
165
  ([!101](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/101)
166
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
167
- Change development status classifier to production/stable 
168
  ([!97](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/97)
169
  by [Normo](https://gitlab.hzdr.de/Normo)).
170
  
171
## [1.0.1](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/releases/v1.0.1) - 2021-06-21
172

173
[List of commits](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/compare/v1.0.0...v1.0.1)
174
175

### Added
176
- Missing documentation for preprocess option of the init command
177
  ([!99](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/99)
178
179
180
181
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).

### Fixed
- Fixed bug where metadata could not be loaded due to missed parenthesis
182
  ([!98](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/98)
183
184
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
  
185
## [1.0.0](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/releases/v1.0.0) - 2021-06-18
186

187
[List of commits](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/compare/v0.3.0...v1.0.0)
188

189
190
### Added
- Added an external configuration file to set defaults for an analysis run
191
  ([!64](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/64)
192
193
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Create files CONTRIBUTING, CHANGELOG, VERSION and adapt file README
194
  ([!66](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/66)
195
196
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Refactor internal structure for OOP-style and add an example analysis script
197
  ([!67](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/67)
198
199
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Add unit test cases for module `data_container`
200
  ([!85](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/85)
201
202
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Add unit test cases for module `question_collection`
203
  ([!80](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/80)
204
205
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Add unit test cases for module `answer_option`
206
  ([!83](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/83)
207
208
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Add unit test cases for module `question`
209
  ([!82](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/82)
210
211
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Refactor models and adapt them to changed metadata structure and elements
212
  ([!72](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/72)
213
214
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
- Add unit test cases for module `settings`
215
  ([!76](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/76)
216
217
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Detect CSV files with gitleaks which is part of the tool SQA
218
  ([!74](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/74)
219
220
  by [Normo](https://gitlab.hzdr.de/Normo)).
- Add file `License.md` to provide license information of the project
221
  ([!90](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/90)
222
223
  by [Normo](https://gitlab.hzdr.de/Normo)).
- Create a getting started guide for the project
224
  ([!84](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/84)
225
226
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Split up object routed to analysis scripts into data container and analysis objects
227
  ([!91](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/91)
228
229
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Add capabilities to add a data preprocessing script to the project
230
  ([!92](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/92)
231
232
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Add URLs of project to file `pyproject.toml` for PyPi.org
233
  ([!73](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/73)
234
235
  by [Normo](https://gitlab.hzdr.de/Normo)).
- Add URL of project documentation to file `pyproject.toml` for PyPi.org
236
  ([!94](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/94)
237
  by [Normo](https://gitlab.hzdr.de/Normo)).
238
- Re-enable access to data as pandas DataFrames
239
  ([!88](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/88)
240
  by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
241
  
242
### Changed
243
- Change Makefile and GitLab CI pipeline
244
  ([!68](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/68)
245
246
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Improve inline documentation and API documentation
247
  ([!69](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/69)
248
249
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Replace default branch names in GitLab CI pipeline with variable `CI_DEFAULT_BRANCH`
250
  ([!89](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/89)
251
252
  by [Normo](https://gitlab.hzdr.de/Normo)).
- Generate and publish project documentation on merges into default branch `main`
253
  ([!93](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/93)
254
255
  by [Normo](https://gitlab.hzdr.de/Normo)).
- Adapt file CHANGELOG to document changes made during the developments
256
  ([!95](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/95)
257
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
258
- Increase version in file `pyproject.toml` to version `1.0.0`
259
  ([!96](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/96)
260
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
261
262

### Fixed
263
- Enable GitLab CI job trigger to run on merges into default branch
264
  ([!70](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/70)
265
266
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Fix infinite recursion in method `add_answer` in module `question`
267
  ([!81](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/81)
268
269
  by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Add missing `__init__.py` files to unit test case packages
270
  ([!87](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/87)
271
272
  by [hueser93](https://gitlab.hzdr.de/hueser93)).

273
## [0.3.0](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/releases/v0.3.0) - 2021-04-22
274

275
[List of commits](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/compare/v0.1.0...v0.3.0)
276
277
278

### Added
- Add SQA tool for software quality assessments during GitLab CI pipeline
279
  ([!60](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/60)
280
281
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Publish project on PyPi.org as `hifis-surveyval`
282
  ([!63](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/63)
283
284
285
286
  by [hueser93](https://gitlab.hzdr.de/hueser93)).

### Changed
- Replace Pipenv by Poetry and add file `pyproject.toml` to project
287
  ([!59](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/59)
288
289
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Rename project to `HIFIS-Surveyval`
290
  ([!62](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/merge_requests/62)
291
292
  by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).

293
## [0.1.0](https://gitlab.hzdr.de/hifis/overall/surveys/hifis-surveyval/-/releases/v0.1.0) - 2021-04-12
294
295

- Initial version of the project.