diff --git a/README.md b/README.md index d0cc7ad80b9bc98e8523ce380f16bbd169bd5fd2..990397da0fe9a1236cfca254bd8855037f01beec 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,6 @@ Packaging informations : - https://packaging.python.org/en/latest/tutorials/packaging-projects/ - https://choosealicense.com/ -## Remark - -The data files do not need to be packaged, just place them where the data -folder is installed. - ## Build and install the package ```shell @@ -74,6 +69,28 @@ Out[4]: 'Study type': 'Observational'}, ``` +## Remark + +The data files do not need to be packaged, just place them where the data +folder is installed. + +WARNING : you have to manually remove the data files copied in the data folder +installed in `site-packages` with pip if you want to remove the package. + +```shell +$ pip uninstall import_resources_example +Found existing installation: import_resources_example 0.0.1 +Uninstalling import_resources_example-0.0.1: + Would remove: + /home/fconil/Progs/python/imports/resources/.venv/lib/python3.10/site-packages/import_resources_example-0.0.1.dist-info/* + /home/fconil/Progs/python/imports/resources/.venv/lib/python3.10/site-packages/import_resources_example/* + Would not remove (might be manually added): + /home/fconil/Progs/python/imports/resources/.venv/lib/python3.10/site-packages/import_resources_example/data/COVID19-web.27-07-2022.csv + /home/fconil/Progs/python/imports/resources/.venv/lib/python3.10/site-packages/import_resources_example/data/WPP2022_TotalPopulationBySex.csv +Proceed (Y/n)? y + Successfully uninstalled import_resources_example-0.0.1 +``` + ## Troubleshooting If we have untracked data files in the package tree, flist refuses to build the @@ -103,4 +120,3 @@ As we can append the data files with `-f`, I will ignore the data file in `.giti $ git add -f WPP2022_TotalPopulationBySex.csv $ ``` -