projectreport package

A set of tools for describing software projects. Finds software projects, analyzes them, and outputs reports.

Subpackages

Submodules

projectreport.config module

projectreport.data module

projectreport.logger module

class projectreport.logger.LogLevel(value)[source]

Bases: str, Enum

An enumeration.

DEBUG = 'DEBUG'
INFO = 'INFO'
class projectreport.logger.LoggingConfig(*args, **kwargs)[source]

Bases: BaseSettings

class Config[source]

Bases: object

env_prefix = 'PROJECT_REPORT_LOG_'
cast_log_level(v)
level: LogLevel = 'INFO'
projectreport.logger.create_logger()[source]
Return type:

Logger

projectreport.parser_types module

projectreport.version module

class projectreport.version.Version(major=None, minor=None, patch=None, prerelease=None, build=None, full_str=None, is_semver=False)[source]

Bases: object

__init__(major=None, minor=None, patch=None, prerelease=None, build=None, full_str=None, is_semver=False)
build: Optional[str] = None
classmethod from_semver_version(version, full_str=None)[source]
Return type:

Version

classmethod from_str(version)[source]
Return type:

Version

full_str: Optional[str] = None
is_semver: bool = False
major: Optional[int] = None
minor: Optional[int] = None
patch: Optional[int] = None
prerelease: Optional[str] = None
property semantic_version: semver.VersionInfo
Return type:

VersionInfo

projectreport.version.add_major_minor_patch_changed_to_df(df)[source]
projectreport.version.add_major_minor_patch_to_df(df, version_col='tag_name')[source]
projectreport.version.major_minor_patch(version)[source]
Return type:

Tuple[Optional[int], Optional[int], Optional[int]]