projectreport.finder package

Submodules

projectreport.finder.base module

class projectreport.finder.base.Finder(recursive=True, required_folders=None, required_files=None, file_extensions=None)

Bases: object

Class for finding projects by required folders or files, or looking for certain file extensions.

__init__(recursive=True, required_folders=None, required_files=None, file_extensions=None)

find(path, ignore_paths=('.*', '__pycache__', 'venv', 'venvs', 'node_modules'))

find_all(paths, ignore_paths=('.*', '__pycache__', 'venv', 'venvs', 'node_modules'))

is_valid(path)

projectreport.finder.combine module

class projectreport.finder.combine.CombinedFinder(finders, recursive=True)

Bases: Finder

Finder which can be passed other specific finders, and will return project paths that match any of the passed finders.

__init__(finders, recursive=True)

is_valid(path)

projectreport.finder.git module

class projectreport.finder.git.GitFinder(recursive=True)

Bases: Finder

Finder that automatically looks for projects with git repositories.

__init__(recursive=True)

projectreport.finder.js module

class projectreport.finder.js.JavaScriptPackageFinder(recursive=True)

Bases: Finder

Finder which automatically looks for projects with JavaScript packages.

__init__(recursive=True)

projectreport.finder.python module

class projectreport.finder.python.PythonPackageFinder(recursive=True)

Bases: Finder

Finder which automatically looks for projects with Python packages.

__init__(recursive=True)