Workflow

[ghodsizadeh]

Summary by Sourcery

Set up CI workflows for linting, formatting, and test coverage reporting. Update the README file with the Codecov badge.

CI:

• Add CI workflows for linting, formatting, and test coverage reporting.

Documentation:

• Add a Codecov badge to the README file.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces GitHub Actions workflows for linting, formatting, and test coverage. It also adds Codecov badge to the README file.

Sequence diagram for PR validation workflow

sequenceDiagram
    actor Developer
    participant PR as Pull Request
    participant GHA as GitHub Actions
    participant Ruff as Ruff Tool
    participant Codecov as Codecov

    Developer->>PR: Create/Update PR
    PR->>GHA: Trigger workflows
    par Parallel workflows
        GHA->>Ruff: Run format check
        GHA->>Ruff: Run linting check
        GHA->>Codecov: Generate coverage report
    end
    Ruff-->>GHA: Format results
    Ruff-->>GHA: Linting results
    Codecov-->>GHA: Coverage results
    GHA-->>PR: Update status checks
    PR-->>Developer: Show results

Loading

File-Level Changes

Change	Details	Files
Adds a linting workflow that runs ruff check on all files.	Installs ruff. Runs ruff check . on the codebase.	.github/workflows/linting.yml
Adds a formatting workflow that runs ruff format on all files.	Installs ruff. Runs ruff format . on the codebase.	.github/workflows/formatting.yml
Adds a test coverage workflow that runs pytest with coverage and uploads the report to Codecov.	Installs pytest and pytest-cov. Runs pytest with coverage enabled. Uploads coverage reports to Codecov.	.github/workflows/test_coverage.yml
Adds a Codecov badge to the README file.	Includes the Codecov badge in the README file.	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @ghodsizadeh - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider updating GitHub Actions to latest versions (checkout@v4, setup-python@v5) for improved features and security
• Instead of Python '3.x', consider specifying exact Python versions to test against (e.g., '3.9', '3.10', '3.11') for better reproducibility

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟡 Security: 1 issue found
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

🚨 suggestion (security): Consider upgrading GitHub Actions versions to latest stable releases (checkout@v4, setup-python@v5)

Using the latest stable versions ensures you have the latest security patches and features.

Suggested implementation:

      uses: actions/checkout@v4

      uses: actions/setup-python@v5

[sourcery-ai]

suggestion (performance): Consider adding dependency caching to speed up workflow execution

Using actions/cache for pip dependencies can significantly reduce workflow execution time.

Suggested implementation:

    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.x'

    - name: Cache pip dependencies
      uses: actions/cache@v3
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt', 'setup.py') }}
        restore-keys: |
          ${{ runner.os }}-pip-

    - name: Install dependencies

Note: This assumes you have a requirements.txt or setup.py file. If you use different files for dependencies (like pyproject.toml or requirements/*.txt), you should adjust the hashFiles() pattern accordingly. The cache key can be customized based on your specific needs.

[codecov-commenter]

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️