packing_packages.install package

packing_packages.install package#

Install packages for the packing_packages project.

This module provides a function to install packages from a specified directory into a conda environment.

$ python -m packing_packages install --help

or

$ packing-packages install --help
packing_packages.install.generate_install_scripts(dirpath_packages: str | PathLike = '.', env_name: str | None = None, output_dir: str | PathLike | None = None, encoding: str | None = None) → dict[str, Path]#

Generate install scripts for Windows and Unix/Linux.

This function generates install scripts that work on Windows (batch) and Unix/Linux (bash), avoiding wildcard expansion issues on Windows. The generated scripts do not depend on this package and can be distributed independently.

Parameters:

  • dirpath_packages (Union[str, os.PathLike], optional) – Directory path containing packages, by default “.”

  • env_name (str, optional) – Conda environment name. If None, uses directory name of dirpath_packages, by default None

  • output_dir (Union[str, os.PathLike], optional) – Output directory for generated scripts. If None, uses dirpath_packages, by default None

  • encoding (str, optional) – Encoding for generated script files. If None, uses system default encoding, by default None

Returns:

Dictionary mapping script types to file paths: - “batch”: Path to .bat file - “shell”: Path to .sh file

Return type:

dict[str, Path]

packing_packages.install.install_packages(env_name: str | None = None, dirpath_packages: str | PathLike = '.', encoding: str | None = None) → None#

Install conda and PyPI packages.

This function installs conda packages and PyPI packages from the specified directory into the specified conda environment. Conda packages are installed first, with Python packages prioritized. Failed installations are logged.

Parameters:

  • env_name (str, optional) – Conda environment name. If None, uses the current conda environment, by default None

  • dirpath_packages (Union[str, os.PathLike], optional) – Directory path containing packages to install, by default “.”

  • encoding (str, optional) – Encoding for subprocess output. If None, uses system default encoding, by default None

Returns:

This function does not return a value. Installation results are logged.

Return type:

None