pySCG: investigate and recommend a list of static code analysis tools

Offen
#10 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
python

Rechercherichtung

Read the contribution guide and its existing mention of Ruff with Bandit, then check the related type hints topic for overlap. Draft a page recommending static and dynamic analysis tools and a minimum tool set for Python coding environments. Done means the guidance covers the listed tool examples and avoids duplicating the type hints topic.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

automated detection of well known code flaws and a common way of formatting can be very helpfull to avoid issues.

This issue is as a placeholder to create a page explaining static code analysis tools as mentioned in our contribution guide (Ruff with configured Bandit) and dynamic analysis tools such as pyre.

It might be required to merge it with the topic on type hints to avoid duplication. We should however provide some sort of solid idea of bare minimum that should be included in every coding ide similar to Compiler Options Hardening Guide for C and C++

Example Static tools:

  • Ruff
  • Pylint
  • Mypy
  • Bandit
  • PyDocstyle
  • Mccabe
  • Vulture
  • SonarQube
  • pep8
  • flake8

Example dynamic tools:

  • PyTest
  • Pytest-cov
  • coverage.py

Test automation:

  • Tox
Vorherrschende Sprache
Python
Sterne
2
Forks
2
Ø Merge
11 Min.
Gemergte PRs (30 T.)
2

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus ossf/python-secure-coding-guide

Alle Issues in ossf/python-secure-coding-guide

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.