Prepare final subpackage release (#735)

* prepare core

* adjust remaining READMEs

* adjust installed subpackages

* slight tweaks to setup.py files

* correct setup.py and remove interpackage deps

* detect deprecated packages

core/README.md

@@ -1,5 +1,5 @@
 # eolearn.core subpackage
 
-The main subpackage which implements basic building blocks (EOPatch, EOTask and EOWorkflow) and commonly used functionalities.
+The deprecated way to install `eolearn.core`. See [migration guide](https://github.com/sentinel-hub/eo-learn/issues/733) on how to correctly install the `eo-learn` package.
 
-For more information about the module visit [readthedocs](https://eo-learn.readthedocs.io/en/latest/reference/eolearn.core.html), or see the [module task index](https://eo-learn.readthedocs.io/en/latest/eotasks.html#core).
+Installs requirements and a dummy package that is detected by `eo-learn` but otherwise does not change anything.

core/deprecated_eolearn_core/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.0"

core/setup.py

@@ -18,7 +18,7 @@ def parse_requirements(file):
 
 
 def get_version():
-    path = os.path.join(os.path.dirname(__file__), "eolearn", "core", "__init__.py")
+    path = os.path.join(os.path.dirname(__file__), "deprecated_eolearn_core", "__init__.py")
     with open(path) as version_file:
         for line in version_file:
             if line.find("__version__") >= 0:
@@ -44,15 +44,12 @@ def get_version():
     author="Sinergise EO research team",
     author_email="[email protected]",
     license="MIT",
-    packages=find_packages(exclude=["eolearn.tests*"]),
-    package_data={"eolearn": ["core/py.typed"]},
-    include_package_data=True,
+    packages=find_packages(),
     install_requires=parse_requirements("requirements.txt"),
     extras_require={
         "RAY": parse_requirements("requirements-ray.txt"),
         "ZARR": parse_requirements("requirements-zarr.txt"),
     },
-    zip_safe=False,
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",

coregistration/README.md

@@ -1,5 +1,5 @@
 # eolearn.coregistration subpackage
 
-A collection of tools and EOTasks for image co-registration
+The deprecated way to install `eolearn.coregistration`. See [migration guide](https://github.com/sentinel-hub/eo-learn/issues/733) on how to correctly install the `eo-learn` package.
 
-For more information about the module visit [readthedocs](https://eo-learn.readthedocs.io/en/latest/reference/eolearn.coregistration.html), or see the [module task index](https://eo-learn.readthedocs.io/en/latest/eotasks.html#coregistration).
+Installs requirements and a dummy package that is detected by `eo-learn` but otherwise does not change anything.

coregistration/deprecated_eolearn_coregistration/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.0"

coregistration/requirements.txt

@@ -1,3 +1,2 @@
 # using headless version of opencv, otherwise gitlab runners fail
-eo-learn-core
 opencv-python-headless

coregistration/setup.py

@@ -18,7 +18,7 @@ def parse_requirements(file):
 
 
 def get_version():
-    path = os.path.join(os.path.dirname(__file__), "eolearn", "coregistration", "__init__.py")
+    path = os.path.join(os.path.dirname(__file__), "deprecated_eolearn_coregistration", "__init__.py")
     with open(path) as version_file:
         for line in version_file:
             if line.find("__version__") >= 0:
@@ -45,9 +45,7 @@ def get_version():
     author_email="[email protected]",
     license="MIT",
     packages=find_packages(),
-    include_package_data=True,
     install_requires=parse_requirements("requirements.txt"),
-    zip_safe=False,
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",

eolearn/__init__.py

@@ -1,2 +1,16 @@
 """Main module of the `eolearn` package."""
 __version__ = "1.4.2"
+
+import importlib.util
+import warnings
+
+SUBPACKAGES = ["core", "coregistration", "features", "geometry", "io", "mask", "ml_tools", "visualization"]
+deprecated_installs = [
+    subpackage for subpackage in SUBPACKAGES if importlib.util.find_spec(f"deprecated_eolearn_{subpackage}") is not None
+]
+if deprecated_installs:
+    warnings.warn(
+        f"You are currently using an outdated installation of `eo-learn` for submodules {deprecated_installs}. You can"
+        " find instructions on how to install `eo-learn` correctly at"
+        " https://github.com/sentinel-hub/eo-learn/issues/733."
+    )

features/README.md

@@ -1,5 +1,5 @@
 # eolearn.features subpackage
 
-A collection of utilities for extracting data properties and feature manipulation.
+The deprecated way to install `eolearn.features`. See [migration guide](https://github.com/sentinel-hub/eo-learn/issues/733) on how to correctly install the `eo-learn` package.
 
-For more information about the module visit [readthedocs](https://eo-learn.readthedocs.io/en/latest/reference/eolearn.features.html), or see the [module task index](https://eo-learn.readthedocs.io/en/latest/eotasks.html#features).
+Installs requirements and a dummy package that is detected by `eo-learn` but otherwise does not change anything.

features/deprecated_eolearn_features/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.0"

features/requirements.txt

@@ -1,4 +1,3 @@
-eo-learn-core
 numba>=0.53.0
 numpy
 pillow>=9.1.0

features/setup.py

@@ -18,7 +18,7 @@ def parse_requirements(file):
 
 
 def get_version():
-    path = os.path.join(os.path.dirname(__file__), "eolearn", "features", "__init__.py")
+    path = os.path.join(os.path.dirname(__file__), "deprecated_eolearn_features", "__init__.py")
     with open(path) as version_file:
         for line in version_file:
             if line.find("__version__") >= 0:
@@ -45,9 +45,7 @@ def get_version():
     author_email="[email protected]",
     license="MIT",
     packages=find_packages(),
-    include_package_data=True,
     install_requires=parse_requirements("requirements.txt"),
-    zip_safe=False,
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",

geometry/README.md

@@ -1,5 +1,5 @@
 # eolearn.geometry subpackage
 
-Geometry subpackage used for geometric transformation and conversion between vector and raster data.
+The deprecated way to install `eolearn.geometry`. See [migration guide](https://github.com/sentinel-hub/eo-learn/issues/733) on how to correctly install the `eo-learn` package.
 
-For more information about the module visit [readthedocs](https://eo-learn.readthedocs.io/en/latest/reference/eolearn.geometry.html), or see the [module task index](https://eo-learn.readthedocs.io/en/latest/eotasks.html#geometry).
+Installs requirements and a dummy package that is detected by `eo-learn` but otherwise does not change anything.

geometry/deprecated_eolearn_geometry/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.0"

geometry/requirements.txt

@@ -1,4 +1,3 @@
-eo-learn-core
 geopandas>=0.8.1
 rasterio>=1.2.7, <1.3.8
 scikit-image>=0.15.0

geometry/setup.py

@@ -18,7 +18,7 @@ def parse_requirements(file):
 
 
 def get_version():
-    path = os.path.join(os.path.dirname(__file__), "eolearn", "geometry", "__init__.py")
+    path = os.path.join(os.path.dirname(__file__), "deprecated_eolearn_geometry", "__init__.py")
     with open(path) as version_file:
         for line in version_file:
             if line.find("__version__") >= 0:
@@ -45,9 +45,7 @@ def get_version():
     author_email="[email protected]",
     license="MIT",
     packages=find_packages(),
-    include_package_data=True,
     install_requires=parse_requirements("requirements.txt"),
-    zip_safe=False,
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",

io/README.md

@@ -1,5 +1,5 @@
 # eolearn.io subpackage
 
-Input/output subpackage that deals with obtaining data from Sentinel Hub services or saving and loading data locally.
+The deprecated way to install `eolearn.io`. See [migration guide](https://github.com/sentinel-hub/eo-learn/issues/733) on how to correctly install the `eo-learn` package.
 
-For more information about the module visit [readthedocs](https://eo-learn.readthedocs.io/en/latest/reference/eolearn.io.html), or see the [module task index](https://eo-learn.readthedocs.io/en/latest/eotasks.html#io).
+Installs requirements and a dummy package that is detected by `eo-learn` but otherwise does not change anything.

io/deprecated_eolearn_io/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.0"

io/requirements.txt

@@ -1,6 +1,5 @@
 affine
 boto3
-eo-learn-core
 fiona>=1.8.18
 geopandas>=0.8.1
 rasterio>=1.2.7, <1.3.8

io/setup.py

@@ -18,7 +18,7 @@ def parse_requirements(file):
 
 
 def get_version():
-    path = os.path.join(os.path.dirname(__file__), "eolearn", "io", "__init__.py")
+    path = os.path.join(os.path.dirname(__file__), "deprecated_eolearn_io", "__init__.py")
     with open(path) as version_file:
         for line in version_file:
             if line.find("__version__") >= 0:
@@ -45,10 +45,8 @@ def get_version():
     author_email="[email protected]",
     license="MIT",
     packages=find_packages(),
-    include_package_data=True,
     install_requires=parse_requirements("requirements.txt"),
     extras_require={"METEOBLUE": parse_requirements("requirements-meteoblue.txt")},
-    zip_safe=False,
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",

mask/README.md

@@ -1,5 +1,5 @@
 # eolearn.mask subpackage
 
-The subpackage is used for masking of data and calculation of cloud masks.
+The deprecated way to install `eolearn.mask`. See [migration guide](https://github.com/sentinel-hub/eo-learn/issues/733) on how to correctly install the `eo-learn` package.
 
-For more information about the module visit [readthedocs](https://eo-learn.readthedocs.io/en/latest/reference/eolearn.mask.html), or see the [module task index](https://eo-learn.readthedocs.io/en/latest/eotasks.html#mask).
+Installs requirements and a dummy package that is detected by `eo-learn` but otherwise does not change anything.

mask/deprecated_eolearn_mask/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.0"

mask/requirements.txt

@@ -1,5 +1,4 @@
 # using headless version of opencv, otherwise gitlab runners fail
-eo-learn-core
 lightgbm>=2.0.11, <4
 numpy
 opencv-python-headless

mask/setup.py

@@ -18,7 +18,7 @@ def parse_requirements(file):
 
 
 def get_version():
-    path = os.path.join(os.path.dirname(__file__), "eolearn", "mask", "__init__.py")
+    path = os.path.join(os.path.dirname(__file__), "deprecated_eolearn_mask", "__init__.py")
     with open(path) as version_file:
         for line in version_file:
             if line.find("__version__") >= 0:
@@ -45,15 +45,7 @@ def get_version():
     author_email="[email protected]",
     license="MIT",
     packages=find_packages(),
-    include_package_data=True,
-    package_data={
-        "eolearn.mask": [
-            "models/pixel_s2_cloud_detector_lightGBM_v0.2.txt",
-            "models/ssim_s2_cloud_detector_lightGBM_v0.2.txt",
-        ]
-    },
     install_requires=parse_requirements("requirements.txt"),
-    zip_safe=False,
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",

ml_tools/README.md

@@ -1,5 +1,5 @@
 # eolearn.ml_tools subpackage
 
-Various tools that can be used before or after the machine learning process.
+The deprecated way to install `eolearn.ml_tools`. See [migration guide](https://github.com/sentinel-hub/eo-learn/issues/733) on how to correctly install the `eo-learn` package.
 
-For more information about the module visit [readthedocs](https://eo-learn.readthedocs.io/en/latest/reference/eolearn.ml-tools.html), or see the [module task index](https://eo-learn.readthedocs.io/en/latest/eotasks.html#ml-tools).
+Installs requirements and a dummy package that is detected by `eo-learn` but otherwise does not change anything.

ml_tools/deprecated_eolearn_ml_tools/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.0"

ml_tools/requirements.txt

@@ -1,3 +1,2 @@
-eo-learn-core
 numpy
 shapely

ml_tools/setup.py

@@ -18,7 +18,7 @@ def parse_requirements(file):
 
 
 def get_version():
-    path = os.path.join(os.path.dirname(__file__), "eolearn", "ml_tools", "__init__.py")
+    path = os.path.join(os.path.dirname(__file__), "deprecated_eolearn_ml_tools", "__init__.py")
     with open(path) as version_file:
         for line in version_file:
             if line.find("__version__") >= 0:
@@ -45,13 +45,11 @@ def get_version():
     author_email="[email protected]",
     license="MIT",
     packages=find_packages(),
-    include_package_data=True,
     install_requires=parse_requirements("requirements.txt"),
     extras_require={
         "PLOTTING": parse_requirements("requirements-plotting.txt"),
         "TDIGEST": parse_requirements("requirements-tdigest.txt"),
     },
-    zip_safe=False,
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",

visualization/README.md

@@ -1,5 +1,5 @@
 # eolearn.visualization subpackage
 
-A collection of data visualization utilities.
+The deprecated way to install `eolearn.visualization`. See [migration guide](https://github.com/sentinel-hub/eo-learn/issues/733) on how to correctly install the `eo-learn` package.
 
-For more information about the module visit [readthedocs](https://eo-learn.readthedocs.io/en/latest/reference/eolearn.visualization.html).
+Installs requirements and a dummy package that is detected by `eo-learn` but otherwise does not change anything.

visualization/deprecated_eolearn_visualization/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.0"

visualization/requirements.txt

@@ -1,4 +1,3 @@
-eo-learn-core
 graphviz>=0.10.1
 jinja2
 matplotlib

visualization/setup.py

@@ -18,7 +18,7 @@ def parse_requirements(file):
 
 
 def get_version():
-    path = os.path.join(os.path.dirname(__file__), "eolearn", "visualization", "__init__.py")
+    path = os.path.join(os.path.dirname(__file__), "deprecated_eolearn_visualization", "__init__.py")
     with open(path) as version_file:
         for line in version_file:
             if line.find("__version__") >= 0:
@@ -46,9 +46,7 @@ def get_version():
     license="MIT",
     packages=find_packages(),
     package_data={"eolearn": ["visualization/report_templates/report.html"]},
-    include_package_data=True,
     install_requires=parse_requirements("requirements.txt"),
-    zip_safe=False,
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",