projectreport.report package

Submodules

projectreport.report.base module

class projectreport.report.base.BaseReport[source]

Bases: object

data()
doc()
json()
Return type:

str

latex()
yaml()
Return type:

str

projectreport.report.json module

projectreport.report.json.to_json(dict_)[source]
Return type:

str

projectreport.report.latex module

class projectreport.report.latex.SubProjectLatex(*args: Any, **kwargs: Any)[source]

Bases: TextAreaMixin, ItemBase

__init__(data, **kwargs)[source]
get_contents(data)[source]
projectreport.report.latex.multi_project_latex(data)[source]
projectreport.report.latex.multi_project_latex_document(data)[source]
Return type:

Document

projectreport.report.latex.project_latex(data)[source]
projectreport.report.latex.project_latex_document(data)[source]
Return type:

Document

projectreport.report.project module

class projectreport.report.project.ProjectReport(project, depth=0)[source]

Bases: BaseReport

__init__(project, depth=0)[source]
data()
Return type:

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

doc()
projectreport.report.project.gather_data(folder, data, remaining_depth=0)[source]

projectreport.report.report module

class projectreport.report.report.Report(projects, depth=0)[source]

Bases: BaseReport

Pass Projects to create a report of the analysis of the projects.

__init__(projects, depth=0)[source]
data()
Return type:

List[dict]

default_sort()[source]
doc()
sort(key=None, reverse=False)[source]