Fixed API exposed by package

Author: Andrey170170

pyproject.toml

@@ -33,7 +33,6 @@ dependencies = [
  "multivolumefile",
  "opencv-python",
  "pillow",
- "pip",
  "psutil",
  "pyarrow",
  "pyyaml",
@@ -44,7 +43,6 @@ dependencies = [
  "python-dotenv",
  "pyzstd",
  "requests",
- "setuptools",
  "texttable",
  "typing-extensions",
  "wheel"

src/distributed_downloader/__init__.py

@@ -1,46 +1,5 @@
-from logging import Logger
-from typing import Optional
+from .core import download_images
+from .tools import apply_tools
 
-from distributed_downloader.core.main import DistributedDownloader
-from distributed_downloader.tools.main import Tools
 
-
-def download_images(config_path: str, logger: Optional[Logger] = None) -> None:
- """
- Initiates the download of images based on a given configuration.
-
- This function creates an instance of `DistributedDownloader` using a configuration file path,
- optionally sets a logger for the downloader, and then starts the image downloading process.
-
- Parameters:
- - config_path (str): The file path to the configuration file required to initialize the downloader.
- - logger (Logger, optional): An instance of a logger to be used by the downloader. Defaults to None.
-
- Returns:
- - None
- """
- dd = DistributedDownloader.from_path(config_path)
- if logger is not None:
- dd.logger = logger
- dd.download_images()
-
-
-def apply_tools(config_path: str, tool_name: str, logger: Optional[Logger] = None) -> None:
- """
- Applies a tool to the images downloaded by the DistributedDownloader.
-
- This function creates an instance of `DistributedDownloader` using a configuration file path,
- optionally sets a logger for the downloader, and then applies the specified tool to the downloaded images.
-
- Parameters:
- - config_path (str): The file path to the configuration file required to initialize the downloader.
- - tool_name (str): The name of the tool to be applied to the downloaded images.
- - logger (Logger, optional): An instance of a logger to be used by the downloader. Defaults to None.
-
- Returns:
- - None
- """
- dd_tools = Tools.from_path(config_path, tool_name)
- if logger is not None:
- dd_tools.logger = logger
- dd_tools.apply_tool()
+__all__ = ["download_images", "apply_tools"]

src/distributed_downloader/core/__init__.py

@@ -0,0 +1,24 @@
+from logging import Logger
+from typing import Optional
+
+from .main import DistributedDownloader
+
+
+def download_images(config_path: str, logger: Optional[Logger] = None) -> None:
+ """
+ Initiates the download of images based on a given configuration.
+
+ This function creates an instance of `DistributedDownloader` using a configuration file path,
+ optionally sets a logger for the downloader, and then starts the image downloading process.
+
+ Parameters:
+ - config_path (str): The file path to the configuration file required to initialize the downloader.
+ - logger (Logger, optional): An instance of a logger to be used by the downloader. Defaults to None.
+
+ Returns:
+ - None
+ """
+ dd = DistributedDownloader.from_path(config_path)
+ if logger is not None:
+ dd.logger = logger
+ dd.download_images()

src/distributed_downloader/tools/__init__.py

@@ -1 +1,29 @@
-import distributed_downloader.tools.schedulers
+from logging import Logger
+from typing import Optional
+
+from .config import Config
+from .checkpoint import Checkpoint
+from .registry import ToolsRegistryBase
+from .main import Tools
+from .utils import load_dataframe, ensure_created, truncate_paths, get_id, init_logger, submit_job, preprocess_dep_ids
+
+
+def apply_tools(config_path: str, tool_name: str, logger: Optional[Logger] = None) -> None:
+ """
+ Applies a tool to the images downloaded by the DistributedDownloader.
+
+ This function creates an instance of `DistributedDownloader` using a configuration file path,
+ optionally sets a logger for the downloader, and then applies the specified tool to the downloaded images.
+
+ Parameters:
+ - config_path (str): The file path to the configuration file required to initialize the downloader.
+ - tool_name (str): The name of the tool to be applied to the downloaded images.
+ - logger (Logger, optional): An instance of a logger to be used by the downloader. Defaults to None.
+
+ Returns:
+ - None
+ """
+ dd_tools = Tools.from_path(config_path, tool_name)
+ if logger is not None:
+ dd_tools.logger = logger
+ dd_tools.apply_tool()