feat(#605): add README and empty migration script

hpi-dhc · May 2, 2023 · 9997d1f · 9997d1f
1 parent 65d9e69
commit 9997d1f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/anni/migration/README.md b/anni/migration/README.md
@@ -0,0 +1,16 @@
+# Anni Migration Scripts
+
+This script can be used to manually migrate Anni data backups after breaking changes.
+
+## Run script
+
+1. Have `python3` installed
+2. Run `pyhthon3 migrate.py <PATH_TO_BACKUP>.json[.base64]`
+3. The script will test what needs to be migrated and write a migrated backup to `<PATH_TO_BACKUP>_migrated.base64`
+
+## Breaking changes covered
+
+* [Add new medications (FDA)](https://github.com/hpi-dhc/PharMe/pull/582)
+* [One annotation per phenotype](https://github.com/hpi-dhc/PharMe/pull/597)
+* [Zipped Anni backup](https://github.com/hpi-dhc/PharMe/pull/599)
+* [Use phenotypes from cpic](https://github.com/hpi-dhc/PharMe/pull/602)
diff --git a/anni/migration/migrate.py b/anni/migration/migrate.py