159 add deprecation warning

BritishGeologicalSurvey / etlhelper

ETL Helper is a Python ETL library to simplify data transfer into and out of databases.

https://britishgeologicalsurvey.github.io/etlhelper/

GNU Lesser General Public License v3.0

100 stars 25 forks source link

159 add deprecation warning #165

Closed leorudczenko closed 1 year ago

leorudczenko commented 1 year ago

Description

This merge request adds a warning which is shown when ETLHelper is imported into a Python script: DeprecationWarning: ETLHelper version 1.0.0 is coming soon and will contain deprecations. Users should pin their versions and check GitHub issues for details.

The branch for_v1 should be rebased using main once this deprecation warning has been merged. Then, once for_v1 is ready, the deprecation warning should be removed.

closes #159

volcan01010 commented 1 year ago

The warning shows as required. I changed the wording slightly and added an example specification for pinning below version 1.