Um aplicativo Github para revisar automaticamente o estilo de código Python sobre solicitações de puxar


pycodestyle ou flake8 como seu linhador. O bot pode ler configurações para ambos.setup.cfg para seções [flake8] e [pycodestyle] . Confira a seção Configuration abaixo. Um arquivo de configuração não é necessário para que a integração funcione . No entanto, ele pode ser configurado adicionalmente adicionando um arquivo .pep8speaks.yml na raiz do projeto. Aqui está um exemplo:
# File : .pep8speaks.yml
scanner :
diff_only : True # If False, the entire file touched by the Pull Request is scanned for errors. If True, only the diff is scanned.
linter : pycodestyle # Other option is flake8
pycodestyle : # Same as scanner.linter value. Other option is flake8
max-line-length : 100 # Default is 79 in PEP 8
ignore : # Errors and warnings to ignore
- W504 # line break after binary operator
- E402 # module level import not at top of file
- E731 # do not assign a lambda expression, use a def
- C406 # Unnecessary list literal - rewrite as a dict literal.
- E741 # ambiguous variable name
no_blank_comment : True # If True, no comment is made on PR without any errors.
descending_issues_order : False # If True, PEP 8 issues in message will be displayed in descending order of line numbers in the file
message : # Customize the comment made by the bot
opened : # Messages when a new PR is submitted
header :
" Hello @{name}! Thanks for opening this PR. "
# The keyword {name} is converted into the author's username
footer :
" Do see the [Hitchhiker's guide to code style](https://goo.gl/hqbW4r) "
# The messages can be written as they would over GitHub
updated : # Messages when new commits are added to the PR
header : " Hello @{name}! Thanks for updating this PR. "
footer : " " # Why to comment the link to the style guide everytime? :)
no_errors : " There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers: "Notas:
.pep8speaks.yml substituirá esses valores..pep8speaks.yml na filial base (a existente). Se o arquivo não for encontrado, ele pesquisa a ramificação head (as alterações recebidas).scanner.linter como pycodestyle ou flake8ignore ou max-line-length ), o Pep8Speaks parecerá e priorizará as configurações na seguinte ordem:pycodestyle: ou flake8: Seção de .pep8speaks.yml .scanner.linter .[pycodestyle] ou [flake8] seção do arquivo setup.cfg na raiz do projeto.scanner.linter . Portanto, a seção [flake8] do setup.cfg também funcionará para o Pycodestyle.| Organização | Descrição | |
|---|---|---|
| Pandas | Poderosas ferramentas de manipulação de dados para python | |
| Adobe | Código aberto da Adobe | |
| OpenSuse | Distribuição Linux | |
| Pytorch Lightning | O invólucro leve Pytorch para pesquisadores de ML. | |
| Networkx | Biblioteca Python para teoria de gráficos e redes complexas | |
| STATSMODELS | Modelagem Estatística e Econometria em Python | |
| Xarray (pydata) | ND rotulou matrizes e conjuntos de dados em Python (Python para dados) | |
![]() | Sunpy | Python para física solar |
| Astropia | Astronomia em Python | |
| Scikit Aprenda Contrib | Projetos compatíveis com Scikit-Learn | |
| Imagem do Scikit | Processamento de imagem em Python | |
| Spyder IDE | O ambiente de desenvolvimento científico de Python | |
![]() | Catalisador | Pytorch Framework para pesquisa e desenvolvimento de aprendizado profundo |
Consulte a lista completa de organizações e usuários.
@pep8speaks suggest diff em um comentário do PR, e ele comentará uma essência do Diff sugerindo correções para o PR. Exemplo@pep8speaks pep8ify no PR e criará uma solicitação de tração com alterações sugeridas pelo autopep8 contra a filial do autor do PR. autopep8 corrige a maioria dos erros relatados pelo pycodestyle .[skip pep8] em qualquer lugar da mensagem de confirmação, título de relações públicas ou descrição de relações públicas para proibir Pep8speaks de comentar sobre a solicitação de tração.Este aplicativo funcionará apenas para repositórios hospedados publicamente. Portanto, se você deseja implantar um garfo ou usar o aplicativo para repositórios privados , aqui estão as instruções.
pep8 ). As atualizações do aplicativo são anunciadas usando o recurso de lançamento do Github aqui. Muitas mudanças importantes são feitas à medida que a comunidade cresce. Clique em Watch -> Releases only na parte superior da página, para ser notificado sobre novas configurações ou atualizações de recursos.
Geralmente, a filial principal é implantada assim que solicitações de tração são mescladas no repositório. No entanto, todas as sextas -feiras, faço uma liberação e verifico que o código mais recente seja implantado. Você não precisa fazer nada para usar a versão mais recente. Se você usar um garfo do Pep 8 fala, confira o espaço de lançamento.
Torne -se um patrocinador de ouro e obtenha seu logotipo e nome com um link para o seu site em nosso ReadMe e nosso site.
Governança de Samagra | ![]() Samagrax |
Torne -se um patrocinador de ouro e obtenha seu logotipo e nome com um link para o seu site em nosso ReadMe e nosso site.
Python Software Foundation | WebLate |
Torne -se um patrocinador de prata e obtenha seu logotipo e nome com um link para o seu site em nosso ReadMe e nosso site.
Ccextractor | Sudhanshu Mishra |
Você pode apoiar o projeto contribuindo para o seu desenvolvimento. Se você tiver alguma sugestão para novos recursos ou melhorias, crie um problema. Solicitações de tração são muito bem -vindas! Leia o DOC contribuinte para entender como o projeto funciona e como você pode fazer alterações.
O projeto precisa ser hospedado em um servidor e, devido ao qual também precisa de suporte financeiro.
Por favor, leia o caso para financiar o Pep 8 fala.
Se você usar este projeto e gostar, entre em contato. Obrigado!
❤️
Este projeto não endossa todas as regras do Pep 8 original e, portanto, acredita na personalização do pycodestyle.
.