Skip to content

Commit cb16120

Browse files
authored
Merge branch 'master' into 50-clowder20-submit-file-to-extractor
2 parents 516fa2f + d704fa7 commit cb16120

File tree

23 files changed

+537
-266
lines changed

23 files changed

+537
-266
lines changed

.github/workflows/pypi.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ on:
1010
jobs:
1111
publish:
1212
name: Build and publish python packages
13-
runs-on: ubuntu-18.04
13+
runs-on: ubuntu-22.04
1414

1515
steps:
16-
- uses: actions/checkout@v2
16+
- uses: actions/checkout@v3
1717

1818
- name: get release info
1919
id: release_info

CHANGELOG.md

Lines changed: 71 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,138 @@
1-
# Change Log
1+
# Changelog
2+
23
All notable changes to this project will be documented in this file.
34

4-
The format is based on [Keep a Changelog](http://keepachangelog.com/)
5-
and this project adheres to [Semantic Versioning](http://semver.org/).
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/)
6+
and this project adheres to [Semantic Versioning](https://semver.org/).
7+
8+
## 3.0.2 - 2023-07-20
9+
10+
### Added
11+
12+
- Support for Clowder V2 visualization and visualization config
13+
endpoints. [#70](https://github.com/clowder-framework/pyclowder/issues/70)
14+
15+
### Fixed
16+
17+
- fix bug with delete. [#38](https://github.com/clowder-framework/pyclowder/issues/38)
18+
19+
## 3.0.1 - 2023-05-25
20+
21+
### Changed
22+
23+
This version updates Clowder 2 functionality to use API Key headers instead of Bearer tokens.
624

725
## 3.0.0 - 2022-12-16
8-
This version adds Clowder 2 support and removes the old method of extractor registration in favor of reliance on heartbeats.
26+
27+
This version adds Clowder 2 support and removes the old method of extractor registration in favor of reliance on
28+
heartbeats.
929

1030
### Added
31+
1132
- api/v1 and api/v2 code split for back compatibility as v2 is introduced.
1233
- new simplified ClowderClient is used in the new split endpoints for future refactoring.
1334

1435
### Removed
36+
1537
- remove RABBITMQ_EXCHANGE parameter and REGISTRATION_URL parameter.
1638
- remove DatasetsAPI and object-oriented ClowderClient.
1739

40+
## 2.7.0 - 2023-02-14
41+
42+
When extractors download a file from clowder it will ask clowder to not track that download.
43+
This will result in only those donwloads to be counted by users, not extractors.
44+
45+
### Changed
46+
47+
- Ask not to track a download from an extractor.
48+
1849
## 2.6.0 - 2022-06-14
1950

2051
This will change how clowder sees the extractors. If you have an extractor, and you specify
2152
the queue name (eiter as command line argument or environment variable) the name of the
2253
extractor shown in clowder, will be the name of the queue.
2354

2455
### Fixed
56+
2557
- both heartbeat and nax_retry need to be converted to in, not string
2658

2759
### Changed
60+
2861
- when you set the RABBITMQ_QUEUE it will change the name of the extractor as well in the
2962
extractor_info document. [#47](https://github.com/clowder-framework/pyclowder/issues/47)
3063
- environment variable CLOWDER_MAX_RETRY is now MAX_RETRY
3164

3265
## 2.5.1 - 2022-03-04
3366

3467
### Changed
68+
3569
- updated pypi documentation
3670

3771
## 2.5.0 - 2022-03-04
3872

3973
### Fixed
74+
4075
- extractor would fail on empty dataset download [#36](https://github.com/clowder-framework/pyclowder/issues/36)
4176

4277
### Added
78+
4379
- ability to set the heartbeat for an extractractor [#42](https://github.com/clowder-framework/pyclowder/issues/42)
4480

4581
### Changed
82+
4683
- update wordcount extractor to not use docker image
4784
- using piptools for requirements
4885

4986
## 2.4.1 - 2021-07-21
5087

5188
### Added
89+
5290
- Add `--max_retry` CLI flag and `CLOWDER_MAX_RETRY` environment variable.
5391

5492
### Changed
93+
5594
- updated all of the requirements to latest versions
5695
- updated github actions to automatically create releases
5796
- use thread.daemon = True to fix python 3.10
5897

5998
## 2.4.0 - 2021-02-22
6099

61100
### Changed
101+
62102
- clowder is no longer the default exchange. Exchanges are no longer used and
63103
this is deprecated.
64104
- fix check for thread is_alive, fixes warning in python 3.9
65105

66106
### Removed
107+
67108
- Removed the extractors.<queue_name> since it was not used.
68109

69110
## 2.3.4 - 2020-10-04
70111

71112
### Fixed
113+
72114
- Extractor would not run in case clowder_url was ""
73115

74116
## 2.3.3 - 2020-10-02
75117

76118
### Fixed
119+
77120
- Thread of heartbeat was set as daemon after start.
78121

79122
## 2.3.2 - 2020-09-24
80123

81124
### Fixed
125+
82126
- When rabbitmq restarts the extractor would not stop and restart, resulting
83127
in the extractor no longer receiving any messages. #17
84128

85129
### Added
130+
86131
- Can specify url to use for extractor downloads, this is helpful for instances
87132
that have access to the internal URL for clowder, for example in docker/kubernetes.
88133

89134
### Removed
135+
90136
- Removed ability to run multiple connectors in the same python process. If
91137
parallelism is needed, use multiple processes (or containers).
92138

@@ -95,6 +141,7 @@ extractor shown in clowder, will be the name of the queue.
95141
With this version we no longer gurantee support for versions of python below 3.
96142

97143
### Fixed
144+
98145
- There was an issue where status messages could cause an exception. This would
99146
prevent most extractors from running correctly.
100147

@@ -109,6 +156,7 @@ From this version no more docker images are build, please use pip install to
109156
install pyclowder.
110157

111158
### Added
159+
112160
- Simple extractors now support datasets, can also create new datasets.
113161
- Ability to add tags from simple extractor to files and datasets.
114162
- Ability to add additional files (outputs) to dataset in simple extractor.
@@ -117,11 +165,13 @@ install pyclowder.
117165
- PyClowderExtractionAbort to indicate the message shoudl not be retried.
118166

119167
### Changed
168+
120169
- Better handling of status messages
121170

122171
## 2.2.3 - 2019-10-14
123172

124173
### Fixed
174+
125175
- Heartbeat of 5 minutes would cause timeouts for RabbitMQ
126176
[CATSPYC-30](https://opensource.ncsa.illinois.edu/jira/browse/CATSPYC-30)
127177
- support uploading large file to dataset.
@@ -130,19 +180,23 @@ install pyclowder.
130180
## 2.2.2 - 2019-09-27
131181

132182
### Changed
183+
133184
- Heartbeat is now every five minutes, was every 5 seconds
134185

135186
### Fixed
187+
136188
- the python3 images were actually python2 images
137189

138190
## 2.2.1 - 2019-08-02
139191

140192
### Changed
193+
141194
- sample extractors had bad extractor_info.json. registry needs to be an array.
142195

143196
## 2.2.0 - 2019-04-03
144197

145198
### Fixed
199+
146200
- Code is now compatible with both Python 2 and Python 3.
147201
- RabbitMQ queue name can be different from extractor name.
148202
- Updated dependencies.
@@ -152,24 +206,29 @@ install pyclowder.
152206
[CATSPYC-18](https://opensource.ncsa.illinois.edu/jira/browse/CATSPYC-18)
153207

154208
### Changed
209+
155210
- files.upload_preview and collections.upload_preview does not require section_id for metadata
156211
[CATS-935](https://opensource.ncsa.illinois.edu/jira/browse/CATS-935)
157212
- Extractors will not register by default to clowder
158213
[CATSPYC-1](https://opensource.ncsa.illinois.edu/jira/browse/CATSPYC-1)
159214

160215
### Added
161-
- Simple R extractor. Allows wrapping R code as a clowder extractor, see sample-extractors/wordcount-simple-r-extractor for an example.
216+
217+
- Simple R extractor. Allows wrapping R code as a clowder extractor, see sample-extractors/wordcount-simple-r-extractor
218+
for an example.
162219
- Email notification when extraction is done
163220
[CATSPYC-17](https://opensource.ncsa.illinois.edu/jira/browse/CATSPYC-17)
164221
- Docker compose file for starting up the Clowder stack
165222
[BD-2226](https://opensource.ncsa.illinois.edu/jira/browse/BD-2226)
166-
- PyClowder will now send heartbeats on extractors exchange, processes can listen for broadcast to get notified when new extractors come online.
223+
- PyClowder will now send heartbeats on extractors exchange, processes can listen for broadcast to get notified when new
224+
extractors come online.
167225
- Monitor application to leverage new heartbeat send out by extractors
168226
- Extractors now send version and name to clowder as part of the agent information.
169227

170228
## 2.1.1 - 2018-07-12
171229

172230
### Fixed
231+
173232
- Error decoding json body from Clowder when filename had special characters
174233
[CATSPYC-18] (https://opensource.ncsa.illinois.edu/jira/browse/CATSPYC-18)
175234
- RABBITMQ_QUEUE variable/flag was ignored when set and would connect
@@ -178,10 +237,12 @@ install pyclowder.
178237
## 2.1.0 - 2018-07-06
179238

180239
### Added
240+
181241
- [Simple extractor](https://opensource.ncsa.illinois.edu/confluence/display/CATS/Simple+Extractor+wrapper+for+basic+functions),
182242
now can create a extractor from a single function.
183243

184244
### Fixed
245+
185246
- Acks were not always send due to racing condition
186247
[CATS-886](https://opensource.ncsa.illinois.edu/jira/browse/CATS-886)
187248
- Queue name was not set from extractor_info.json
@@ -190,12 +251,16 @@ install pyclowder.
190251
## 2.0.3 - 2018-04-18
191252

192253
### Added
254+
193255
- push to pypi (can now do pip install pyclowder)
194256
- added binary-preview-extractor which can be configured using environment
195257
variables (see sample-extractors/binary-preview/README.rst).
196258

197259
### Changed
260+
198261
- Now has onbuild version of pyclowder
199262
- release.sh will now tag images (e.g. this will be tagged 2.0.3 2.0 and 2)
200263
- RABBITMQ_URI is now set to amqp://guest:guest@rabbitmq/%2F to allow easy deployment
201264
using docker-compose of clowder
265+
266+
[unreleased]: https://github.com/clowder-framework/pyclowder/compare/3.0.1...HEAD

0 commit comments

Comments
 (0)