MartinHeinz / python-project-blueprint

Blueprint/Boilerplate For Python Projects
MIT License
958 stars 231 forks source link

Adding isort and black #3

Open jonasrk opened 4 years ago

jonasrk commented 4 years ago

Thanks, this is a real game changer for me! :)

If I were to customize it for myself, I would add auto-formatting with black and auto-sorting-imports with isort.

Potentially, I would also add https://github.com/python-poetry/poetry or make it obvious somewhere that it should be used.

Oh, and I think some tools (e.g. flake8, pylint) should also appear in requirements.txt ?

Happy to open a PR if you like any of those ideas. :)

MartinHeinz commented 4 years ago

First of all, thanks for suggestions and sorry for late response.

Regarding these suggested additions:

About the requirements.txt - flake8, pylint... are not in requirements.txt because the application is not dependent on these tools. If they were added to requirements.txt, that would mean that they would be also part of final image which doesn't really make sense. These tools are specifically downloaded in GitHub Actions Jobs, when the checks are ran.