runtime_dependency_manager

runtime_dependency_manager is a simple Python module for managing dependencies at runtime. It is designed for small scripts that do not use a requirements.txt file. This module allows you to define and install dependencies directly within your script, making it ideal for quick scripts and prototypes.

Installation

You can install runtime_dependency_manager using pip:

pip install runtime_dependency_manager

Usage

Here's an example of how to use runtime_dependency_manager in your script, which could be done programmatically using the from_module, import_module, and as_module methods:

try:
    from runtime_dependency_manager import RuntimeDependencyManager
except ImportError:
    print(
        f"Error: missing required package runtime_dependency_manager.\n"
        f"Please install via:\n"
        f"\tpip install runtime_dependency_manager")
    sys.exit(1)

with RuntimeDependencyManager(install_if_missing=True) as mgr:
    mgr.index_url = "https://pypi.org/simple"

    with mgr.package('IPy', '>=1.1') as pkg:
        pkg.from_module('IPy').import_modules('IP', 'IPSet')

    with mgr.package('pymongo', '>=3.11.4, <4.0.0') as pkg:
        pkg.import_module('pymongo')
        pkg.from_module('bson').import_module('ObjectId')

    with mgr.package('paramiko', '==2.7.2') as pkg:
        pkg.from_module('paramiko').import_modules(
            'SSHClient', 'AutoAddPolicy', 'SSHConfig', 'SSHException')

    with mgr.package('pyyaml', '>=5.4.1, <6.0.0', optional=True) as pkg:
        pkg.import_module('yaml')

Alternatively, if you don't need to programmatically import anything, you could help your IDE (e.g., VS Code, PyCharm, etc) be aware of your imports by doing the following:

try:
    from runtime_dependency_manager import RuntimeDependencyManager
except ImportError:
    print(
        f"Error: missing required package runtime_dependency_manager.\n"
        f"Please install via:\n"
        f"\tpip install runtime_dependency_manager")
    sys.exit(1)

with RuntimeDependencyManager() as mgr:
    # tries to install package addict and then runs the 'with' code block if
    # the install was successful
    with mgr.immediately_install_package('addict', '>=2.0'):
        from addict import Dict as NestedDict

    # tries to install package pymongo and then runs the 'with' code block if
    # the install was successful
    with mgr.immediately_install_package('pymongo', '>=3.11.0, <4.0.0'):
        import pymongo
        from bson import ObjectId

    # tries to install package PyYAML and then runs the 'with' code block if
    # the install was successful. Internally verifies installation using the
    # provided 'module_name' (yaml), instead of the package name (PyYAML)
    with mgr.immediately_install_package('PyYAML', '>=6', module_name='yaml'):
        import yaml

    # tries to install package __nonexistant-package_ and then runs the 'with'
    # code block if the install was successful. 
    with mgr.immediately_install_package('_nonexistant-package_', '>1.0'):
        # this import statement never runs because the package fails to 
        # install.
        import fooblahbaz

API

RuntimeDependencyManager

RuntimeDependencyManager(install_if_missing=False, index_url=None, extra_index_urls=None, trusted_hosts=None)

• install_if_missing: Whether to install missing packages automatically.
• index_url: The base URL of the Python Package Index.
• extra_index_urls: Additional URLs of package indexes.
• trusted_hosts: List of trusted hosts.

Methods

• package(name, version_spec=None, optional=False): Adds a package to the dependency list of packages to install, which happens at the end of the with RuntimeDependencyManager with block.
• immediately_install_package(name:str, version_spec:str=None, module_name:str=None): Immediately installs the package, using the optionally provided module_name to verify it's installation

Package

Methods

• import_module(module_name): Adds an import statement for the specified module.
• import_modules(*modules): Adds import statements for multiple modules.
• from_module(from_name): Converts an 'import x' statement to a 'from y import x' statement, when combined with import_module(s)
• as_module(alias): Specifies an alias for the imported module.

License

This project is licensed under the GPLv3 License - see the LICENSE file for details.

Contributing

If you would like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.

1. Fork the project.
2. Create a feature branch (git checkout -b feature-branch).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.

Acknowledgments

• The Python community for the packaging module.
• Anyone who has contributed to this project.