Skip to content

Commit 3e99e07

Browse files
authored
Add migration guide for next release (#210)
1 parent a2d10d3 commit 3e99e07

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

CHANGELOG.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Changes are grouped as follows
1919

2020
* Legacy authentication through API keys has been removed throughtout the code
2121
base.
22+
23+
* A few deprecated modules (`authentication`, `prometheus_logging`) have been
24+
deleted.
2225

2326
### Changed
2427

@@ -48,6 +51,63 @@ Changes are grouped as follows
4851
guide](https://github.com/cognitedata/cognite-sdk-python/blob/master/MIGRATION_GUIDE.md#from-v5-to-v6)
4952
for the SDK for details on the changes it entails for users.
5053

54+
* Several small single-function modules have been removed and the content have
55+
been moved to the catch-all `util` module. This includes:
56+
57+
- The `add_extraction_pipeline` decorator from the `extraction_pipelines`
58+
module
59+
60+
- The `throttled_loop` generator from the `throttle` module
61+
62+
- The `retry` decorator from the `retry` module
63+
64+
65+
### Migration guide
66+
67+
The deletion of API keys and the legacy OAuth2 implementation should not affect
68+
your extractors or your usage of the utils unless you were depending on the old
69+
OAuth implementation directly and not through `configtools` or the base classes.
70+
71+
To update to version 5 of extractor-utils, you need to
72+
73+
* Change where you import a few things.
74+
75+
- Change from
76+
``` python
77+
from cognite.extractorutils.extraction_pipelines import add_extraction_pipeline
78+
```
79+
to
80+
``` python
81+
from cognite.extractorutils.util import add_extraction_pipeline
82+
```
83+
84+
- Change from
85+
``` python
86+
from cognite.extractorutils.throttle import throttled_loop
87+
```
88+
to
89+
``` python
90+
from cognite.extractorutils.util import throttled_loop
91+
```
92+
93+
- Change from
94+
``` python
95+
from cognite.extractorutils.retry import retry
96+
```
97+
to
98+
``` python
99+
from cognite.extractorutils.util import retry
100+
```
101+
102+
* Consult the [migration
103+
guide](https://github.com/cognitedata/cognite-sdk-python/blob/master/MIGRATION_GUIDE.md#from-v5-to-v6)
104+
for the Cognite SDK version 6 for details on the changes it entails for
105+
users.
106+
107+
The changes in this version are only breaking for your usage of the utils. Any
108+
extractor you have written will not be affected by the changes, meaning you do
109+
not need to bump the major version for your extractors.
110+
51111
## [4.3.1]
52112

53113
### Changed

0 commit comments

Comments
 (0)