pep8speaks
pep8speaks is back again!
Eine Github -App, um den Python -Code -Stil automatisch über Pull -Anfragen zu überprüfen
pycodestyle oder flake8 als Flecken verwenden. Der Bot kann Konfigurationen für beide lesen.setup.cfg für Abschnitte [flake8] und [pycodestyle] lesen. Schauen Sie sich den folgenden Configuration an. Eine Konfigurationsdatei ist nicht erforderlich, damit die Integration funktioniert . Es kann jedoch zusätzlich durch Hinzufügen einer .pep8speaks.yml -Datei in das Stamm des Projekts konfiguriert werden. Hier ist ein Beispiel:
# 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: "Anmerkungen:
.pep8speaks.yml wird diese Werte überschreiben..pep8speaks.yml im base (der vorhandene). Wenn die Datei nicht gefunden wird, durchsucht sie den head (die eingehenden Änderungen).scanner.linter flake8 pycodestyleignore max-line-lengthpycodestyle: oder flake8: Abschnitt von .pep8speaks.yml .scanner.linter -Wert ab.[pycodestyle] oder [flake8] Abschnitt der setup.cfg -Datei im Stamm des Projekts.scanner.linter . Der Abschnitt von setup.cfg [flake8] funktioniert also auch für Pycodestyle.| Organisation | Beschreibung | |
|---|---|---|
| Pandas | Leistungsstarke Datenmanipulationstools für Python | |
| Adobe | Open Source von Adobe | |
| OpenSuse | Linux -Verteilung | |
| Pytorch Lightning | Die leichte Pytorch -Wrapper für ML -Forscher. | |
| NetworkX | Python Library für Graphentheorie und komplexe Netzwerke | |
| StatsModels | Statistische Modellierung und Ökonometrie in Python | |
| Xarray (Pydata) | ND mit der Bezeichnung von Arrays und Datensätzen in Python (Python für Daten) | |
 | Sonnenhilfe | Python für Solarphysik |
| Astropie | Astronomie in Python | |
| Scikit lern live | scikit-larn kompatible Projekte | |
| Scikit -Bild | Bildverarbeitung in Python | |
| Spyder ide | Die wissenschaftliche Pythonentwicklungsumgebung | |
 | Katalysator | Pytorch -Framework für Deep Learning Research and Development |
Siehe die vollständige Liste von Organisationen und Benutzern.
@pep8speaks suggest diff in einem Kommentar der PR vor und kommentiert einen Kern der Diff, die Fixes für die PR vorschlagen. Beispiel@pep8speaks pep8ify auf der PR und es wird eine Pull -Anfrage mit Änderungen erstellt, die von autopep8 gegen den Zweig des Autors der PR vorgeschlagen wurden. autopep8 behebt die meisten von pycodestyle gemeldeten Fehler.[skip pep8] überall in der Commit -Nachricht, der PR -Titel oder der PR -Beschreibung hinzu, um Pep8speaks zu verbieten, die Pull -Anfrage zu kommentieren.Diese App wird nur für öffentlich gehostete Repositorys gearbeitet. Wenn Sie also eine Gabel bereitstellen oder die App für private Repositorys verwenden möchten, finden Sie hier die Anweisungen.
pep8 bekannt). Updates an der App werden mit der GitHub -Release -Funktion hier bekannt gegeben. Viele wichtige Änderungen werden vorgenommen, wenn die Gemeinschaft größer wird. Klicken Sie auf Watch -> Releases only oben auf der Seite, um über neue Konfigurationen oder Funktionsaktualisierungen informiert zu werden.
Normalerweise wird der Master -Zweig bereitgestellt, sobald Pull -Anfragen im Repository zusammengeführt werden. An jedem Freitag mache ich jedoch eine Veröffentlichung und stelle sicher, dass der neueste Code bereitgestellt wird. Sie müssen nichts tun, um die neueste Version zu verwenden. Wenn Sie eine Gabel von PEP 8 -Speaks verwenden, lesen Sie den Release -Raum.
Werden Sie Goldsponsor und erhalten Sie Ihr Logo und Ihren Namen mit einem Link zu Ihrer Website auf unserem Readme und unserer Website.
Samagra Governance |  Samagrax |
Werden Sie Goldsponsor und erhalten Sie Ihr Logo und Ihren Namen mit einem Link zu Ihrer Website auf unserem Readme und unserer Website.
Python Software Foundation | Webblate |
Werden Sie Silbersponsor und holen Sie sich Ihr Logo und Ihren Namen mit einem Link zu Ihrer Website auf unserem Readme und unserer Website.
Ccextractor | Sudhanshu Mishra |
Sie können das Projekt unterstützen, indem Sie zu seiner Entwicklung beitragen. Wenn Sie Vorschläge für neue Funktionen oder Verbesserungen haben, erstellen Sie bitte ein Problem. Pull -Anfragen sind herzlich willkommen! Lesen Sie dazu bei, DOC zu verstehen, um zu verstehen, wie das Projekt funktioniert und wie Sie Änderungen vornehmen können.
Das Projekt muss auf einem Server gehostet werden und benötigt auch finanzielle Unterstützung.
Bitte lesen Sie den Fall für die Finanzierung von PEP 8 Speaks.
Wenn Sie dieses Projekt verwenden und es mögen, lassen Sie es mich bitte wissen. Danke!
❤️
Dieses Projekt unterstützt nicht alle Regeln des ursprünglichen Pep 8 und glaubt daher daran, Pycodestyle anzupassen.
.
