eshwen / ds-python-boilerplate Goto Github PK

Can replace flake8, isort, and pydocstyle. And use it as a pre-commit hook

https://github.com/charliermarsh/ruff

Ideally, just maintain everything in pyproject.toml, and use the poetry export command to export to requirements.txt and requirements-dev.txt. So I could potentially remove the latter two files from the repo, and they can be generated by the user. However, they would need to install poetry first, which could be an annoying step. An alternative would be to generate the requirements files with a pre-commit hook

It would then make sense for the .github./actions/builder/action.yml to use Poetry and install the project that way

• Explain more behind MkDocs
  • Including the extensions I'm using
• Explain some of the packages in requirements/toml
• Explain toml file
• Explain the pipelines in more detail
  • Including composite action

It can be irritating if your IDE's code styling conflicts with your formatting/linting tools.

For PyCharm, there's a wealth of configuration options for Python code styling. They can also be imported and exported. So, configuration files can be created that mirror your existing formatting/linting tools, so that a lot of things can be applied transparently in the IDE. Then there would be fewer (or no) changes to be made from pipeline failures

So,

1. Decide on a convention for code styling with the formatting tools (black/isort/pydocstyle or ruff)
2. Mirror those in PyCharm's Python code style in Preferences | Editor | Code Style | Python
3. Hit the three dots menu to export it to XML
4. Open a PR with the file (in a .pycharm/ directory?), and instructions on how to import it

For the builder action, use Poetry commands to install instead of pip

Also separate out the tests and quality checks so issues can be seen easier. Use concurrency and caching where possible

3.10 - 3.12 for broad compatibility. Then also update the pipelines to use a matrix of these versions, and the badge in the README:

![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue?logo=Python&logoColor=yellow&link=https%3A%2F%2Fwww.python.org%2F)

Tools for Python coding like black, isort, and mypy can be configured directly in pyproject.toml. So it makes sense to consolidate them all there. See

• black
  • https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-format
• isort
  • https://pycqa.github.io/isort/docs/configuration/options.html
  • https://pycqa.github.io/isort/docs/configuration/config_files.html#pyprojecttoml-preferred-format
  • https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#isort
• mypy
  • https://mypy.readthedocs.io/en/stable/config_file.html#example-pyproject-toml
• flake8 (with an additional package)
  • https://pypi.org/project/Flake8-pyproject/
• pydocstyle
  • https://www.pydocstyle.org/en/stable/snippets/config.html
• pytest
  • https://docs.pytest.org/en/6.2.x/customize.html#pyproject-toml

Then I think I can remove the scripts that run these tools, and just add instructions to run them directly from the README (like black .). I can also add badges like ,

Ruff now has a formatter that's a drop-in replacement for Black: https://docs.astral.sh/ruff/formatter/

So, test it out and see if it's better. Update the docs accordingly

Add a .github/CODEOWNERS file for automatic reviewers, with comments as to how it should be used

See https://github.com/release-drafter/release-drafter#configuration

Avoids having to manually create new releases in GitHub when incrementing versions. I would just need to ensure the versions are properly incremented in pyproject.toml