★ wanayoo — archive 1999 https://github.com/python-cmd2/cmd2/issues/930Nouvelle recherche | Portail wanayoo
Skip to content

/ cmd2

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

Jump to bottom

black, isort, and doc8 - should we use them in our CI? #930

Open
tleonhardt opened this issue Apr 25, 2020 · 2 comments
Open

black, isort, and doc8 - should we use them in our CI? #930

tleonhardt opened this issue Apr 25, 2020 · 2 comments
Labels
question

Comments

@tleonhardt
Copy link
Member

@tleonhardt tleonhardt commented Apr 25, 2020 •
edited

black is an extremely popular tool for automatically formatting Python code to match the very opinionated black coding standard.

isort is a tool for automatically sorting Python imports to match a given style.

doc8 is a Sphinx style checker.

mypy is an optional static type checker

Should we incorporate one or more of these tools into our CI process similar to how we have incorporated flake8? Of course, we can tweak the default configuration for each of these tools to make them match our stylistic preferences if we desire.
@tleonhardt tleonhardt added the question label Apr 25, 2020
@tleonhardt tleonhardt changed the title black and isort - should we use them? black, isort, and doc8 - should we use them in our CI? Apr 25, 2020
@xNinjaKittyx
Copy link
Contributor

@xNinjaKittyx xNinjaKittyx commented May 3, 2020

On top of CI, nowadays its pretty popular to run them with pre-commit

black is great, but I do know there's some people that don't agree with its styling sometimes... (but I prefer it way more than yapf in any scenario).

isort can sometimes be a little annoying to configure if you have any python files that do things on import.
@tleonhardt
Copy link
Member Author

@tleonhardt tleonhardt commented Jul 9, 2020

I believe we should use all of these as part of our CI build/test process. We should also use mypy as part of that process, but we might want to wait until after we deprecate support for Python 3.5 for that one.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
question
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@xNinjaKittyx @tleonhardt
You can’t perform that action at this time.