projectreport.analyzer package

Subpackages

Submodules

projectreport.analyzer.analysis module

class projectreport.analyzer.analysis.Analysis(analyzable)[source]

Bases: object

__init__(analyzable)[source]
data()
property full_loc: Optional[int]
Return type:

Optional[int]

property loc: Optional[int]
Return type:

Optional[int]

class projectreport.analyzer.analysis.FolderAnalysis(folder)[source]

Bases: Analysis

__init__(folder)[source]
add_module_analysis(analysis)[source]
add_subfolder_analysis(analysis)[source]
property full_loc: int
Return type:

int

property loc: int
Return type:

int

class projectreport.analyzer.analysis.GitAnalysis(analyzable)[source]

Bases: object

__init__(analyzable)[source]
commits()
Return type:

Optional[List[Commit]]

created()
Return type:

Optional[datetime]

has_remote()
Return type:

bool

has_repo()
Return type:

bool

num_commits()
Return type:

Optional[int]

updated()
Return type:

Optional[datetime]

urls()
Return type:

Optional[List[str]]

class projectreport.analyzer.analysis.ModuleAnalysis(module)[source]

Bases: Analysis

__init__(module)[source]

projectreport.analyzer.analyzable module

class projectreport.analyzer.analyzable.Analyzable(path, project=None)[source]

Bases: object

__init__(path, project=None)[source]
analysis: Optional[Analysis] = None
data()
Return type:

Dict[str, Union[Dict[str, Union[ForwardRef, str, int, None, date, datetime]], str, int, None, date, datetime]]

docstring()
Return type:

Optional[str]

license()
Return type:

Optional[License]

name: Optional[str] = None
parser: Optional[Parser] = None
topics()
Return type:

Optional[List[str]]

version()
Return type:

Optional[Version]

projectreport.analyzer.folder module

class projectreport.analyzer.folder.Folder(path, project=None, excluded_types=None, included_types=None, ignore_paths=('.*', '__pycache__', 'venv', 'venvs', 'node_modules'))[source]

Bases: Analyzable

__init__(path, project=None, excluded_types=None, included_types=None, ignore_paths=('.*', '__pycache__', 'venv', 'venvs', 'node_modules'))[source]
analysis()
Return type:

FolderAnalysis

file_names()
Return type:

List[str]

file_paths()
Return type:

List[str]

folder_paths()
Return type:

List[str]

folders()
Return type:

List[Folder]

is_empty()
Return type:

bool

modules()
Return type:

List[Module]

parser()
Return type:

Optional[Parser]

projectreport.analyzer.module module

class projectreport.analyzer.module.Module(path, package=None, project=None)[source]

Bases: Analyzable

__init__(path, package=None, project=None)[source]
parser()
Return type:

Optional[Parser]

projectreport.analyzer.project module

class projectreport.analyzer.project.Project(path, excluded_types=None, included_types=None, ignore_paths=('.*', '__pycache__', 'venv', 'venvs', 'node_modules'))[source]

Bases: Folder

Pass a project path to get analysis about the project.

__init__(path, excluded_types=None, included_types=None, ignore_paths=('.*', '__pycache__', 'venv', 'venvs', 'node_modules'))[source]
repo()
Return type:

Optional[Repo]