pip_rating.req_files package

Submodules

pip_rating.req_files.base module

class pip_rating.req_files.base.ReqFileBase(path: str | Path)

Bases: list

Base class for requirement files.

classmethod find_in_directory(directory: str | Path) → ReqFileBase | None

Find requirement file in the given directory.

get_dependencies() → List[str]

Get the dependencies from the file.

classmethod is_valid(path: str | Path) → bool

Check if the given path is a valid requirement file.

pip_rating.req_files.package_list module

class pip_rating.req_files.package_list.PackageList(packages: List[str])

Bases: ReqFileBase

Package list.

classmethod find_in_directory(directory: str | Path) → ReqFileBase | None

Find requirement file in the given directory.

get_dependencies() → List[str]

Get the dependencies.

classmethod is_valid(path: str | Path) → bool

Check if the given path is a valid requirement file.

pip_rating.req_files.pipfile module

class pip_rating.req_files.pipfile.PipfileReqFile(path: str | Path)

Bases: ReqFileBase

Parse packages from Pipfile file.

classmethod find_in_directory(directory: str | Path) → PipfileReqFile

Find setup.cfg in the given directory.

get_dependencies() → List[str]

Get the dependencies from the Pipfile file.

classmethod is_valid(path: str | Path) → bool

Check if the given path is a valid Pipfile file.

pip_rating.req_files.pyproject module

class pip_rating.req_files.pyproject.PyprojectReqFile(path: str | Path)

Bases: ReqFileBase

Parse dependencies from pyproject.toml file.

classmethod find_in_directory(directory: str | Path) → PyprojectReqFile

Find pyproject.toml in the given directory.

get_dependencies() → List[str]

Get the dependencies from the pyproject.toml file.

classmethod is_valid(path: str | Path) → bool

Check if the given path is a valid pyproject.toml file.

pip_rating.req_files.pyproject.poetry_version(version: str | dict | None) → str

Convert Poetry version to PEP440 version.

pip_rating.req_files.requirements module

class pip_rating.req_files.requirements.RequirementsReqFile(path: str | Path)

Bases: ReqFileBase

Requirements requirement file.

classmethod find_in_directory(directory: str | Path) → ReqFileBase | None

Find requirement file in the given directory.

get_dependencies() → List[str]

Get the dependencies from the requirements file.

classmethod is_valid(path: str | Path) → bool

Check if the given path is a valid requirement file.

pip_rating.req_files.setupcfg module

class pip_rating.req_files.setupcfg.SetupcfgReqFile(path: str | Path)

Bases: ReqFileBase

Parse install_requires from Setup.cfg file.

classmethod find_in_directory(directory: str | Path) → SetupcfgReqFile

Find setup.cfg in the given directory.

get_dependencies() → List[str]

Get the dependencies from the setup.cfg file.

classmethod is_valid(path: str | Path) → bool

Check if the given path is a valid setup.cfg file.

pip_rating.req_files.setuppy module

class pip_rating.req_files.setuppy.SetuppyReqFile(path: str | Path)

Bases: ReqFileBase

Parse install_requires from Setup.py file.

classmethod find_in_directory(directory: str | Path) → SetuppyReqFile

Find setup.py in the given directory.

get_dependencies() → List[str]

Get the dependencies from the setup.py file.

classmethod is_valid(path: str | Path) → bool

Check if the given path is a valid setup.py file.

Module contents

pip_rating.req_files.find_in_directory(directory: str | Path) → ReqFileBase

Find requirement file in the given directory.

pip_rating.req_files.get_req_file_cls(path: str | Path) → Type[ReqFileBase]

Get the requirement file class for the given path.