Skip to main content

A simple Python module for managing dependencies at runtime

Project description

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:

try:
    from runtime_dependency_manager import RuntimeDependencyManager
except ImportError:
    print(f"Error: missing required package runtime_dependency_manager. 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')

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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runtime_dependency_manager-0.1.7.tar.gz (40.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runtime_dependency_manager-0.1.7-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file runtime_dependency_manager-0.1.7.tar.gz.

File metadata

File hashes

Hashes for runtime_dependency_manager-0.1.7.tar.gz
Algorithm Hash digest
SHA256 5d3bc495f22f7c41c7a588a522ce3f4463d98c2e14dfc429c468be0e325cce84
MD5 a222c62a3dce6ab435de78e7d9b94b88
BLAKE2b-256 8b606351523059e057aa46d0e9db6a5e3739f98d30335af0d9376baf0ebb1d36

See more details on using hashes here.

File details

Details for the file runtime_dependency_manager-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for runtime_dependency_manager-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 510890c1cc1c85bf64c6e89a2b12f450b25c9d1aeb65515174b56b9735a5aa99
MD5 8d31bec2d5125707a73274dd407adc70
BLAKE2b-256 a76bfa8a9369993148d474e79e5d9a2acc09c5a984b256b34e15db15a8fb64f9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page