Add ci to each pull request that runs tests and lints

[zkoppert]

This pull request introduces several enhancements and refinements to the GitHub User Engagement Metrics module and its associated test suite. Key updates include the addition of comprehensive docstrings for improved code clarity, refactoring for consistency in variable naming, better error handling, and the inclusion of a CI workflow for Python testing. These changes collectively improve maintainability, readability, and reliability of the codebase.

Continuous Integration Setup

• Added a new GitHub Actions workflow (.github/workflows/python-ci.yml) to run Python tests and linting across multiple Python versions (3.11 and 3.12). This includes caching pip dependencies and using flake8 and pylint for linting.

Dependency Updates

• Added types-requests to requirements-test.txt to improve type checking for the requests library.

Testing Enhancements

• Expanded test suite for user_engagement_metrics.py with detailed docstrings for each test function, improving clarity and maintainability. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]

Code Refactoring and Documentation

• Refactored user_engagement_metrics.py functions for improved readability and consistency, including renaming parameters (e.g., username to user) and adding docstrings to all functions. [1] [2] [3] [4]
• Enhanced error handling in the main script to differentiate between network errors and data errors.
• Replaced inline imports with from re import search for better modularity.

Additional Improvements

• Added UTF-8 encoding to file operations in user_engagement_metrics.py to ensure compatibility across environments.

[Copilot]

Pull Request Overview

This PR adds a new GitHub Actions workflow to automate dependency installation, linting, and testing across Python 3.11 and 3.12 for each push and pull request on main.

• Introduces .github/workflows/python-ci.yml
• Configures a matrix build for Python 3.11 and 3.12
• Defines steps: checkout, setup Python, install dependencies, lint, and run tests

Comments suppressed due to low confidence (1)

.github/workflows/python-ci.yml:23

• [nitpick] Pinning the actions/checkout action to a specific commit SHA can lead to maintenance overhead. Consider using a semantic version tag like actions/checkout@v4 to receive non-breaking updates automatically.

-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

[Copilot]

Pull Request Overview

This PR adds a Python CI workflow and enriches the user engagement metrics module with documentation, error handling, and encoding support, alongside expanding the test suite.

• Introduces .github/workflows/python-ci.yml to run linting and tests on multiple Python versions.
• Adds docstrings, timeouts, encoding, and refined error catching in user_engagement_metrics.py.
• Enhances tests in test_user_engagement_metrics.py and updates dev dependencies in requirements-test.txt.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File	Description
user_engagement_metrics.py	Added docstrings, timeout to safe_get, encoding for file I/O, and more specific exception handling.
test_user_engagement_metrics.py	Expanded test fixtures with docstrings and temp-path patching; added new tests.
requirements-test.txt	Included types-requests for type checking.
.github/workflows/python-ci.yml	Configured GitHub Actions to cache dependencies, lint, and run pytest across Python versions.

Comments suppressed due to low confidence (4)

test_user_engagement_metrics.py:16

• pytest is used here but not imported; add import pytest at the top of the file.

@pytest.fixture(autouse=True)

test_user_engagement_metrics.py:29

• The module user_engagement_metrics is referenced but not imported; add import user_engagement_metrics.

user_engagement_metrics, "USERNAMES_FILE", str(tmp_path / "usernames.txt")

user_engagement_metrics.py:101

• [nitpick] Parameter name user_name is inconsistent with other functions using user; consider renaming to username for consistency.

def get_user_repos(user_name):

user_engagement_metrics.py:167

• [nitpick] Parameter type_ is ambiguous; consider renaming to contribution_type to clarify its purpose.

def search_user_contributions(user, type_):