Skip to content

Conversation

@gmmajal
Copy link
Contributor

@gmmajal gmmajal commented Dec 4, 2025

Relevant issue: #104

Background info: # any relevant background info for additional context, references to documentations etc.

  • A code formatting style has not been incorporated yet in stwfsapy. We have decided to opt for black.
  • To simplify development workflow, pre-commit hooks should be added to stwfsapy.

Changes introduced: # list changes to the code repo made in this pull request

  • black and pre-commit have been added as dev dependencies inside the pyproject.toml file.
  • A pre-commit config file has been added. It contains hooks for black and ruff.
  • The version of ruff has been bumped to the version being used inside the .pre-commit.config.yaml file.
  • The poetry.lock file has been updated, respectively to reflect the new packages and dependencies.
  • A new step has been added inside one of our github workflow files. More specifically, we run a code formatting check inside the .github/workflows/ci.yml file.
  • The README.md file has included a badge for Black. Furthermore, some comments have been added in the Contribute section.

@gmmajal gmmajal requested a review from annakasprzik December 4, 2025 14:36
@gmmajal gmmajal self-assigned this Dec 4, 2025
@gmmajal gmmajal marked this pull request as draft December 4, 2025 14:52
@codecov
Copy link

codecov bot commented Dec 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (80d58b6) to head (648011b).
⚠️ Report is 7 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #108   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           16        16           
  Lines          943       943           
=========================================
  Hits           943       943           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gmmajal
Copy link
Contributor Author

gmmajal commented Dec 4, 2025

Additional changes introduced:

  • Code formatting compliance with Black failed earlier. 51 scripts have been modified in the repository to comply with Black.

@gmmajal gmmajal marked this pull request as ready for review December 4, 2025 15:13
Copy link
Contributor

@annakasprzik annakasprzik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good -- I guess we have seen the warning about check/scan before.

@gmmajal
Copy link
Contributor Author

gmmajal commented Dec 4, 2025

Looks good -- I guess we have seen the warning about check/scan before.

Yes, for the time being the deprecation warning coming from safety our security scanner is not an issue. For more context you could follow the discussions over here: pyupio/safety#663, if you are interested.

@gmmajal gmmajal merged commit 42798a1 into zbw:master Dec 4, 2025
7 checks passed
@gmmajal gmmajal deleted the 104-add-black-and-pre-commit-hook branch December 12, 2025 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants