Recommended files
A module to find and identify a set of recommended files, like README, CONTRIBUTING, etc.
It can query GitHub or GitLab projects, and tries to follow the recommendations of the Eclipse Project Handbook [1] and the former analyser [2].
[1] https://www.eclipse.org/projects/handbook/ [2] https://www.eclipse.org/projects/tools/documentation.php
It looks for a set of files for each category of best practices, namely:
- Readme -
readmeorreadme.md - Conduct -
code_of_conduct.md - Contributing -
contributingorcontributing.md - License -
license
It only looks for files at the root of the repository. Search is case-insensitive.
RecommendedFilesAnalyser
Bases: AnalyserEMO
Checks Eclipse project repositories for recommended files.
analyse_project(project_id, credentials=None, verbose=False)
Generic entrypoint to analyse a project. Identifies the project repositories and their type (github/gitlab) and runs the corresponding checks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_id
|
str
|
Project ID of the Eclipse project to analyse, e.g. |
required |
credentials
|
Optional[dict]
|
A dict containing GitHub and GitLab tokens. |
None
|
verbose
|
bool
|
Should we print more information on stdout? |
False
|