Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding pyptoject.toml and initial code quality workflows #24

Merged
merged 4 commits into from
Feb 2, 2024

Conversation

davidslusser
Copy link
Contributor

@davidslusser davidslusser commented Feb 2, 2024

Pull Request

Description:
Adding pyptoject.toml and initial code quality workflows. I strongly recommend using the toml file for tooling parameters to keep configuration consolidated and the root of the repo clean. I added workflows for bandit, black, and ruff (I think we all agree on these). There are many more we can add, but I'll let others take a stab at some before adding more.

Related Issues:

Checklist:

  • All tests pass.
  • Code follows the project's coding standards.
  • Documentation has been updated.

@davidslusser davidslusser self-assigned this Feb 2, 2024
@davidslusser davidslusser linked an issue Feb 2, 2024 that may be closed by this pull request
@joeriddles
Copy link
Contributor

I think the pyproject.toml file may have been missed in the commit

@davidslusser
Copy link
Contributor Author

davidslusser commented Feb 2, 2024

I think the pyproject.toml file may have been missed in the commit

actually, I missed multiple files somehow, doh! @joeriddles updated in the latest commit.

@joeriddles
Copy link
Contributor

joeriddles commented Feb 2, 2024

Noice! Should we just use ruff as both a linter and formatter and drop black altogether?

https://docs.astral.sh/ruff/formatter/

As such, the formatter is designed as a drop-in replacement for Black, but with an excessive focus on performance and direct integration with Ruff. Given Black's popularity within the Python ecosystem, targeting Black compatibility ensures that formatter adoption is minimally disruptive for the vast majority of projects.

@davidslusser
Copy link
Contributor Author

Noice! Should we just use ruff as both a linter and formatter and drop black altogether?

https://docs.astral.sh/ruff/formatter/

As such, the formatter is designed as a drop-in replacement for Black, but with an excessive focus on performance and direct integration with Ruff. Given Black's popularity within the Python ecosystem, targeting Black compatibility ensures that formatter adoption is minimally disruptive for the vast majority of projects.

Noice! Should we just use ruff as both a linter and formatter and drop black altogether?

https://docs.astral.sh/ruff/formatter/

As such, the formatter is designed as a drop-in replacement for Black, but with an excessive focus on performance and direct integration with Ruff. Given Black's popularity within the Python ecosystem, targeting Black compatibility ensures that formatter adoption is minimally disruptive for the vast majority of projects.

I'm open to that. I'll remove it for now, can easily re-add if ppl want more quality tools.

@davidslusser davidslusser merged commit f379a97 into main Feb 2, 2024
0 of 2 checks passed
@joeriddles joeriddles deleted the 12-determine-code-styling-tools branch May 11, 2024 03:32
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.

Determine code styling tools
2 participants