Skip to content

Commit

Permalink
Add migration guide from legacy CDK to current CDK (#3860)
Browse files Browse the repository at this point in the history
  • Loading branch information
sherifnada committed Jun 4, 2021
1 parent 36e2b2b commit 30c1e95
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions airbyte-cdk/python/docs/legacy_cdk_migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Migration guide for

Basic outline of changes for each module:

1. Update `setup.py` to pull airbyte-cdk and remove legacy packages
2. rename `main_dev.py` to `main.py`
3. add `main.py` to `.dockerignore` with the inclusion pattern `!main.py`
4. Update Dockerfile to inherit python docker image directly, remove dead code, and use main.py as entrypoint
5. Remove `requirements.txt`
6. Update imports in python code to use the new CDK package. No code has been removed, only reorganized, so this be as simple as removing all imports from `base_python`, `base_singer`, and `airbyte_protocol` and using the appropriate import paths from the CDK.

## Example
See this PR for an example of migrating a module to the new CDK structure: https://github.com/airbytehq/airbyte/pull/3302

0 comments on commit 30c1e95

Please sign in to comment.