Welcome to Project Report documentation!

To get started, look here.

• Getting started with project-report
  • Install
  • Usage

An overview

Finder

projectreport.finder.base.Finder([...])	Class for finding projects by required folders or files, or looking for certain file extensions.
projectreport.finder.git.GitFinder([recursive])	Finder that automatically looks for projects with git repositories.
projectreport.finder.python.PythonPackageFinder([...])	Finder which automatically looks for projects with Python packages.
projectreport.finder.combine.CombinedFinder(finders)	Finder which can be passed other specific finders, and will return project paths that match any of the passed finders.

Project

projectreport.analyzer.project.Project(path)

Pass a project path to get analysis about the project.

Report

projectreport.report.report.Report(projects)

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

API Documentation

A full list of modules

• projectreport
  • projectreport package
    • Subpackages
    • Submodules
    • projectreport.config module
    • projectreport.data module
    • projectreport.logger module
    • projectreport.parser_types module
    • projectreport.version module

Indices and tables

• Index

• Module Index

• Search Page