pixee / python-dependency-manager

python-dependency-manager

use cases:

• to infer a project's dependency file
  • at this time only requirements.txt supported
• to programmatically update the dependency file

API:

The goal of dependency manager is to allow you to modify your project's stated dependencies - inside txt file - during the course of your program. As such, we provide a DependencyManagerAbstract. The first step is to define your own manager:

# app_manager.py
from pathlib import Path
from dependency_manager import DependencyManagerAbstract

class DependencyManager(DependencyManagerAbstract):
    def get_parent_dir(self):
        """Must return a `pathlib.Path` object, but can use `os.getcwd()` or anything else"""
        return Path("/some/path")

Your DependencyManager is a now a Singleton with one stated parent directory. This means that all the inference work done at initialization will be cached for all except for calls to DependencyManager(). This work includes calling get_parent_dir, finding the dependency file within the parent_directory you define, etc.

Once you've defined your manager, you can now use it:

from app_manager import DependencyManager

DependencyManager().add(["requests==2.8.8"])
...
DependencyManager().add(["requests==*"])
...
DependencyManager().remove(["pylint==*"])

# Once you are ready to update the dependency file:
DependencyManager().write()