Eclipse CLI Assessment and Recommendation Engine

Description

Eclipse CARE lets you assess any Eclipse project regarding Eclipse open source best practices, and get recommendations for improvement.

Its features include:

• Recommended files (e.g. README, LICENSE, SECURITY, etc.) in repositories (Implemented).
• Copyright headers checks (Implemented).
• IP and license management (Coming Soon).
• Headers generator (Coming Soon).

Resources

Official Documentation - Detailed guides, API reference, and architecture.

To learn more about the Eclipse way on open source best practices, see:

• The Eclipse project handbook.

The EMO team also provides several trainings, resources and presentations:

• Eclipse project governance articles on eclipse.org.
• Committer training resources for developers and maintainers.
• EMO Office hours to ask us anything!

Installation

Eclipse CARE requires Python 3.10 or higher. You can install the package directly from PyPI:

pip install eclipse-care

Or from the source:

1. Clone the repository.
2. Get Hatch to build the tool.
3. Build and install the tool:

hatch build
pip install dist/eclipse_care-*.whl

Usage

Once installed, you can use the eclipse-care command:

Arguments:

• project_id: The Eclipse project ID to assess (e.g., technology.dash).

Options:

• -c, --conf: path to an .ini file containing GitHub/GitLab authentication tokens.
• -m, --modules: Specify which modules to run (e.g., care.legal.recommended_files).
• -v, --verbose: Display more verbose information during execution.
• -V, --version: Show the version and exit.
• --html HTML: Write results to the provided HTML file.
• --json JSON: Write results to the provided JSON file.

Authentication credentials for GitLab and GitHub can be provided either in a classic .ini file (see the documentation) or in environment variables:

• GH_AUTH_TOKEN: Your GitHub Personal Access Token.
• GL_AUTH_TOKEN: Your GitLab Personal Access Token.

Please note that, for GitHub API public access, the API rate limits are very low. It's very likely that you'll get rate limited if you don't provide a GH_TOKEN.

Examples

To analyze a specific project using its ID:

eclipse-care technology.dash

To run with verbose output and a configuration file for credentials:

eclipse-care technology.dash --conf my_config.ini --verbose

To run only a specific module:

eclipse-care technology.dash --modules care.legal.recommended_files

Support

If you need help or have questions, please use the following channels:

• Issue Tracker: Report bugs or request features on our GitLab instance (preferred).
• Mailing List: Engage with the community via the Eclipse dash-dev mailing list.

Contributing

We are open to contributions! We recommend the following workflow:

• Submit an issue describing the feature or bug.
• Fork the repository and submit a MR.

We aim to review issues and code, and provide feedback diligently.

See the full documentation in the docs/ directory for more information about the coding guidelines and expected resources (e.g. tests, documentation).

Acknowledgment

Eclipse CARE is made possible thanks to the following open-source projects:

• PyGithub and python-gitlab: For interacting with repository hosting platforms.
• scancode-toolkit-mini and typecode-libmagic: For advanced license and file type detection.
• colorama: For providing cross-platform terminal text coloring.
• hatchling: For the build system and package management.
• pytest: For our testing infrastructure.
• mkdocs-material: For generating our project documentation.

License

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0, which is available at http://www.eclipse.org/legal/epl-2.0.