nmk_github.info

Miscellaneous project information resolvers

Classes

GithubUserResolver

Github user resolving logic

GithubRepoResolver

Github repo resolving logic

GithubIssuesLabelResolver

Github issues query optional label resolver

GithubLicenseParser

License file parser

Module Contents

class nmk_github.info.GithubUserResolver(model: nmk.model.model.NmkModel)

Bases: _GithubRemoteParser

Github user resolving logic

get_value(name: str) str

Gets Github user from git remote URL

Parameters:

name – config item name

Returns:

parsed user name

class nmk_github.info.GithubRepoResolver(model: nmk.model.model.NmkModel)

Bases: _GithubRemoteParser

Github repo resolving logic

get_value(name: str) str

Gets Github repo from git remote URL

Parameters:

name – config item name

Returns:

parsed repo name

class nmk_github.info.GithubIssuesLabelResolver(model: nmk.model.model.NmkModel)

Bases: nmk.model.resolver.NmkStrConfigResolver

Github issues query optional label resolver

get_value(name: str, label: str) str

If githubIssuesLabel is set, provides additional query parameter for it

Parameters:
  • name – config item name

  • label – provided label, if any

Returns:

issues query additional parameter for provided label

class nmk_github.info.GithubLicenseParser(model: nmk.model.model.NmkModel)

Bases: nmk.model.resolver.NmkStrConfigResolver

License file parser

get_value(name: str, file: str) str

Parse license file to read first line

Parameters:

file – license file path