Une application GitHub pour examiner automatiquement le style de code Python sur les demandes de traction


pycodestyle ou flake8 comme linter. Le bot peut lire des configurations pour les deux.setup.cfg pour les sections [flake8] et [pycodestyle] . Consultez la section Configuration ci-dessous. Un fichier de configuration n'est pas requis pour que l'intégration fonctionne . Cependant, il peut être configuré en plus en ajoutant un fichier .pep8speaks.yml dans la racine du projet. Voici un exemple:
# 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: "Notes:
.pep8speaks.yml remplacera ces valeurs..pep8speaks.yml dans la branche base (celui existant). Si le fichier n'est pas trouvé, il recherche ensuite la branche head (les modifications entrantes).scanner.linter sur pycodestyle ou flake8ignore ou max-line-length ), Pep8Speaks aura l'air et hiérarchisera les configurations dans l'ordre suivant:pycodestyle: ou flake8: Section de .pep8speaks.yml .scanner.linter .[pycodestyle] ou [flake8] Section du fichier setup.cfg dans la racine du projet.scanner.linter . Ainsi, la section [flake8] de setup.cfg fonctionnera également pour le pyodestyle.| Organisation | Description | |
|---|---|---|
| Pandas | Outils de manipulation de données puissants pour Python | |
| Adobe | Open source d'Adobe | |
| ouverte | Distribution Linux | |
| Foudre pytorch | L'emballage Pytorch léger pour les chercheurs ML. | |
| NetworkX | Bibliothèque Python pour la théorie des graphiques et les réseaux complexes | |
| Statistiques | Modélisation statistique et économétrie à Python | |
| xarray (pydata) | ND TABLEAUX ET TEMPS ET DES DONNÉES EN PYTHON (Python pour les données) | |
![]() | Bouton solaire | Python pour la physique solaire |
| Astropie | Astronomie en python | |
| Scikit Learn Contrib | Projets compatibles Scikit-Learn | |
| Image Scikit | Traitement d'image en Python | |
| Spyder IDE | L'environnement de développement python scientifique | |
![]() | Catalyseur | Framework Pytorch pour la recherche et le développement en profondeur |
Voir la liste complète des organisations et des utilisateurs.
@pep8speaks suggest diff dans un commentaire du PR, et il commentera un gist de diff suggérant des correctifs pour le PR. Exemple@pep8speaks pep8ify sur le PR et il créera une demande de traction avec des modifications suggérées par autopep8 contre la branche de l'auteur du PR. autopep8 corrige la plupart des erreurs rapportées par pycodestyle .[skip pep8] n'importe où dans le message de validation, le titre de relations publiques ou la description de PR pour interdire à Pep8Speaks de commenter la demande de traction.Cette application ne fonctionnera que pour des référentiels hébergés publiquement. Donc, si vous cherchez à déployer une fourche ou à utiliser l'application pour des référentiels privés , voici les instructions.
pep8 ). Les mises à jour de l'application sont annoncées à l'aide de la fonction de version GitHub ici. Beaucoup de changements majeurs sont apportés à mesure que la communauté augmente. Cliquez sur Watch -> Releases only en haut de la page, pour être informé des nouvelles configurations ou des mises à jour de fonctionnalités.
Habituellement, la branche maître est déployée dès que les demandes de traction sont fusionnées dans le référentiel. Cependant, chaque vendredi, je fais une version et je m'assure que le dernier code est déployé. Vous n'avez rien à faire pour utiliser la dernière version. Si vous utilisez une fourche de Pep 8, consultez l'espace de libération.
Devenez un sponsor d'or et obtenez votre logo et votre nom avec un lien vers votre site sur notre ReadMe et notre site Web.
Gouvernance de samagra | ![]() Samagrax |
Devenez un sponsor d'or et obtenez votre logo et votre nom avec un lien vers votre site sur notre ReadMe et notre site Web.
Python Software Foundation | Enrouler |
Devenez un sponsor d'argent et obtenez votre logo et votre nom avec un lien vers votre site sur notre ReadMe et notre site Web.
Ccextractor | Sudhanshu Mishra |
Vous pouvez soutenir le projet en contribuant à son développement. Si vous avez des suggestions de nouvelles fonctionnalités ou améliorations, veuillez créer un problème. Les demandes de traction sont les bienvenues! Lisez le document contribuant à comprendre le fonctionnement du projet et comment vous pouvez apporter des modifications.
Le projet doit être hébergé sur un serveur et en raison de laquelle il a également besoin d'un support financier.
Veuillez lire le cas pour financer Pep 8 parle.
Si vous utilisez ce projet et que vous l'aimez, faites-le moi savoir. Merci!
❤️
Ce projet n'approuve pas toutes les règles du PEP 8 d'origine et croit ainsi à la personnalisation du pydésyle.
.