Copyright Headers
analyse_project(project_id, credentials=None, verbose=False)
Generic entrypoint to analyze a project. This function will identify the project repositories and their type (GitHub/GitLab) and execute the corresponding functions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_id
|
str
|
Project ID of the Eclipse project to analyze, e.g. |
required |
credentials
|
Optional[dict]
|
A mapping of service providers (GitHub, GitLab) to their respective authentication tokens. |
None
|
verbose
|
Optional[bool]
|
Should we print more information on stdout? |
False
|
gh_analyze(organization, credentials=None, verbose=False)
Analyze a list of GitHub repositories, looking for copyright headers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization
|
str
|
GitHub organization to analyze. |
required |
credentials
|
Optional[dict]
|
A mapping of service providers (GitHub, GitLab) to their respective authentication tokens. |
None
|
verbose
|
Optional[bool]
|
Should we print more information on stdout? |
False
|
gl_analyze(group, credentials=None, verbose=False)
Analyze a list of GitLab repositories, looking for copyright headers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group
|
list
|
GitLab group to analyze. |
required |
credentials
|
Optional[dict]
|
A mapping of service providers (GitHub, GitLab) to their respective authentication tokens. |
None
|
verbose
|
Optional[bool]
|
Should we print more information on stdout? |
False
|