pytest coverage badge!

[ryansurf]

General:

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Code:

1. Does your submission pass tests?
2. Have you run the linter/formatter on your code locally before submission?
3. Have you updated the documentation/README to reflect your changes, as applicable?
4. Have you added an explanation of what your changes do?
5. Have you written new tests for your changes, as applicable?

Summary by Sourcery

Integrate Codecov into the CI workflow to track test coverage and update the README with a Codecov badge.

New Features:

• Add Codecov integration to the CI workflow to upload test coverage results.

Enhancements:

• Update the CI workflow to run tests and collect coverage using pytest with a coverage report in XML format.

CI:

• Modify the GitHub Actions workflow to include a step for uploading coverage results to Codecov.

Documentation:

• Add a Codecov badge to the README to display the current test coverage status.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request integrates Codecov into the CI workflow to report test coverage and adds a Codecov badge to the README. The main changes involve modifying the GitHub Actions workflow file to include Codecov for test coverage reporting and updating the README to display the coverage status.

File-Level Changes

Files	Changes
.github/workflows/pytest.yml	Refactored the CI workflow to improve clarity and organization of steps
.github/workflows/pytest.yml	Updated the test running step to use pytest with coverage reporting in XML format
.github/workflows/pytest.yml	Added a step to upload test coverage results to Codecov
.github/workflows/pytest.yml	Commented out the previous pytest coverage comment step
README.md	Added a Codecov badge to display test coverage status

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Hey @ryansurf - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

• Hard-coded Codecov token found in README. (link)

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🔴 Security: 1 blocking issue
• 🟢 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 to tell me if it was helpful.}

[sourcery-ai]

🚨 issue (security): Hard-coded Codecov token found in README.

It's important to avoid exposing tokens in public files like README.md. Consider using environment variables or GitHub secrets to manage sensitive information.

[codecov]

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.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

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

[sourcery-ai]

Hey @ryansurf - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

• Hard-coded Codecov token found in README. (link)

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🔴 Security: 1 blocking issue
• 🟢 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 to tell me if it was helpful.}

[sourcery-ai]

suggestion: Remove commented-out code

Consider removing the commented-out sections if they are no longer needed. This will improve the readability and maintainability of the workflow file.

[sourcery-ai]

🚨 issue (security): Hard-coded Codecov token found in README.

It's important to avoid exposing tokens in public files like README.md. Consider using environment variables or GitHub secrets to manage sensitive information.