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

pep8 aaaaaaall the way #565

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

juliatessler
Copy link

What is the purpose of this Pull Request?
Fix #546

What was done to achieve this purpose?
Run isort for all files (this makes files comply with PEP8)

How to test if it really works?
Just run the regular unit tests of the repo and see that nothing is broken

Who can help reviewing it?
Anyone who understands the repo

TODO
none

P.S.: I know this is a damn long PR. Please, let me know if you'd like me to break it and how I should partition it (:

@ogecece ogecece added the hacktoberfest-accepted Hacktoberfest label label Oct 27, 2021
@ogecece
Copy link
Member

ogecece commented Oct 27, 2021

_

Oi, @juliatessler ! Muito massa esse feito :)

Queria propôr a gente continuar mantendo o código formatado. O que acha de inserir uma github action pra fazer esse check? pre-commit pra formatar automaticamente também seria uma boa...

Inclusive, não precisamos seguir o PEP8 à risca e usar algo como Black.

Me diz o que você acha e qualquer coisa posso ajudar o/


English

Hi, @juliatessler ! Very nice achievement :)

I'd like to make the proposition for us to keep the code formatted. What do you think about a github action to make this check? pre-commit to format it automatically would also be nice...

Actually, we don't need to strictly follow PEP8 and can use something like Black.

Tell me what you think and I can help if needed o/

@juliatessler
Copy link
Author

juliatessler commented Oct 27, 2021

Oi @giuliocc!

Acho super justo, mas não tenho a menor idéia de como faz isso hahaha
Tentei algo usando o autoyapf, mas não tenho muitas idéias de como testar... Se puder dar uma olhada e sugestões, agradeço muito (:

@ogecece
Copy link
Member

ogecece commented Oct 27, 2021

@juliatessler

Aeeee! Com prazer :)

Essa live do Dunossauro com o Willian Lopes cobre bem tudo que você precisaria saber sobre o assunto (formatação de código, CI, Github Actions, etc.). Se quiser exemplos de repositórios que utilizam essas ferramentas tem a toolbox e o de raspadores do Querido Diário (que usam black, flake8 e isort).

Qualquer coisa pode chamar :)


English

Weeeew! Be my guest :)

This live from Dunossauro with Willian Lopes covers pretty much everything you would need to know about this subject (code formatting, CI, Github Actions, etc.). If you also want examples of repos that use those tools there are the Querido Diário's toolbox and spiders repos (that use black, flake8 and isort).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Hacktoberfest label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review
2 participants