Tidying

[Stoops-ML]

• Tox runs ruff format -diff.
• Remove suggestion to run tox -e reformat from readme.
• GitHub action automatically applies linting (ruff, trailing-whitespace and end-of-file-fixer) to PRs. Note that a .pre-commit-config.yaml file was added to the repo for running pre-commit. Also, bots must be given read and write permissions to make commits:
  

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.28%. Comparing base (56632e3) to head (bf9d1e0).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #153   +/-   ##
=======================================
  Coverage   99.28%   99.28%           
=======================================
  Files          12       12           
  Lines         837      837           
=======================================
  Hits          831      831           
  Misses          6        6           

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

[Stoops-ML]

Lint GitHub Action fails because it doesn't have read and write permission to make commits:

Error: Error: To https://github.com/poliastro/czml3
!	refs/heads/tidying:refs/heads/tidying	[remote rejected] (refusing to allow a GitHub App to create or update workflow `.github/workflows/workflow.yml` without `workflows` permission)

See top comment to apply the required change to allow the action to make commits. After doing so re-run the action and all checks should pass.

[astrojuanlu]

Reading from the UI, these are the default permissions. "You can specify more granular permissions in the workflow using YAML."

Can't we just change the YAML?

[astrojuanlu]

Also while we're at it... is this essentially equivalent to https://pre-commit.ci/ ?

[Stoops-ML]

Reading from the UI, these are the default permissions. "You can specify more granular permissions in the workflow using YAML."

Can't we just change the YAML?

Sure, can you set a new secrets.WORKFLOW_TOKEN (see here).

Also while we're at it... is this essentially equivalent to https://pre-commit.ci/ ?

Yep. The only reason why I added pre-commit was to use the end-of-file-fixer and trailing-whitespace automations they have. If you want I can move ruff into the pre-commit config file too and have all linting done from there.