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

Abierto
#10 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
python

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Python
Estrellas
2
Forks
2
Merge medio
11 min
PR fusionados (30 d)
2

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ossf/python-secure-coding-guide

Todos los issues de ossf/python-secure-coding-guide

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.