readme for v1 / v2 migration #17
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
derhuerst
approved these changes
Apr 22, 2024
|
|
||
| If you want to migrate a v1 or v2 converter, you can re-use some of the code. There is a paradigm change, though: `parkapi-source-v3` | ||
| enforces a strict validation after transforming the data, while v1 and v2 converters don't. ParkAPI v1 / v2 converters are always pull | ||
| converters, so the base class is always `PullConverter`. |
There was a problem hiding this comment.
Coming from v1/v2, I wouldn't know what sets v3's PullConverter apart from other mechanisms that v3 offers. You could mention them briefly here.
| enforces a strict validation after transforming the data, while v1 and v2 converters don't. ParkAPI v1 / v2 converters are always pull | ||
| converters, so the base class is always `PullConverter`. | ||
|
|
||
| Instead of defining `POOL`, you will set `source_info` at the same place. Attributes are almost the same, except for `id` was renamed to |
There was a problem hiding this comment.
Where is this "same place"? As an instance field on the converter class?
hbruch
reviewed
Apr 26, 2024
|
|
||
| Afterwards, you can put the GeoJSON file to `/data`. | ||
|
|
||
| Please keep in mind that you will have to add tests for the migrated scraper. |
There was a problem hiding this comment.
You could reference an example of a migrated scraper, it's v2 version, the migrated v3 version and it's test.
hbruch
approved these changes
Apr 26, 2024
the-infinity
force-pushed
the
migration-readme
branch
from
5e3280b to
85dc6dc
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a description how to migrate v1 / v2 converter.