Glossary

Bandit

Bandit is a tool designed to find common security issues in Python code.

Source Code:

github.com/PyCQA/bandit/

Package:

pypi.org/project/bandit/

Documentation:

bandit.readthedocs.io/

build

A simple, correct Python build frontend.

Source Code:

github.com/pypa/build/

Package:

pypi.org/project/build/

Documentation:

build.pypa.io/

Codacy

Todo

Add description of Codacy.

Cloud Service:

Codacy.com

CodeCov

Todo

Add description of CodeCov.

Cloud Service:

Codecov.io

Coverage.py

The code coverage tool for Python.

Source Code:

github.com/nedbat/coveragepy/

Package:

pypi.org/project/coverage/

Documentation:

coverage.readthedocs.io/

delete-artifact

A GitHub Action to deletes artifacts within the workflow run.

Source Code:

github.com/GeekyEggo/delete-artifact/

Marketplace:

github.com/marketplace/actions/delete-artifact/

README:

github.com/GeekyEggo/delete-artifact → README.md

download-artifact

GitHub Action downloading artifacts within a workflow run. GitHub: pyTooling/download-artifact wraps GitHub: actions/download-artifact and unpacks the tarball created by upload-artifact, so file modes and symbolic links are restored.

Source Code:

github.com/pyTooling/download-artifact/

Marketplace:

github.com/marketplace/actions/pytooling-download-artifact/

docstr_coverage

Docstring coverage analysis and rating for Python.

Source Code:

github.com/HunterMcGushion/docstr_coverage/

Package:

pypi.org/project/docstr_coverage/

Documentation:

docstr-coverage.readthedocs.io/

gh

GitHub’s official command line tool.

Source Code:

github.com/cli/cli/

Documentation:

cli.github.com/manual/

GitHub Pages

GitHub Pages is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website.

Documentation:

https://docs.github.com/en/pages

interrogate

Explain yourself! Interrogate a codebase for docstring coverage.

Source Code:

github.com/econchick/interrogate/

Package:

pypi.org/project/interrogate/

Documentation:

interrogate.readthedocs.io/

MikTeX

MiKTeX is a modern TeX distribution for Windows, Linux and macOS.

Source Code:

github.com/MiKTeX/miktex/

Documentation:

miktex.org/

pyTooling/MiKTeX

Docker images shipping a MikTeX installation with latexmk and a set of preinstalled LaTeX packages, so a LaTeX document can be translated to PDF without downloading packages at build time. The sphinx tag adds the packages Sphinx emits into its LaTeX output.

Source Code:

github.com/pyTooling/MiKTeX/

Docker Image:

pytooling/miktex

mypy

Optional static typing for Python.

Source Code:

github.com/python/mypy/

Package:

pypi.org/project/mypy/

Documentation:

www.mypy-lang.org/

pyEDAA.Reports

A collection of various (EDA tool-specific) report data formats.

Source Code:

github.com/edaa-org/pyEDAA.Reports/

Package:

pypi.org/project/pyEDAA.Reports/

Documentation:

edaa-org.github.io/pyEDAA.Reports/

pip

The Python package installer.

Source Code:

github.com/pypa/pip/

Package:

pypi.org/project/pip/

Documentation:

pip.pypa.io/

pylint

Static code analyzer for Python. It checks a code base without running it and reports errors, violations of coding conventions, code smells and refactoring suggestions. Each finding has a category and an identifier (e.g. C0116), so individual checks can be enabled, disabled or configured per project.

Source Code:

github.com/pylint-dev/pylint/

Package:

pypi.org/project/pylint/

Documentation:

pylint.readthedocs.io/

PyPI

Find, install and publish Python packages with the Python Package Index.

Cloud Service:

PyPI.org

pytest

The pytest framework makes it easy to write small tests, yet scales to support complex functional testing.

Source Code:

github.com/pytest-dev/pytest/

Package:

pypi.org/project/pytest/

Documentation:

pytest.org/

radon

Computes code metrics for Python code:

  • Raw metrics - lines of code, logical lines, comment lines, blank lines.

  • Cyclomatic complexity - the number of linearly independent paths through a function, graded from A to F.

  • Halstead metrics - vocabulary, length, volume, difficulty, effort and the estimated number of bugs, derived from the operators and operands in the code.

  • Maintainability index - a single score combining cyclomatic complexity, lines of code and comment ratio.

Source Code:

github.com/rubik/radon/

Package:

pypi.org/project/radon/

Documentation:

radon.readthedocs.io/

Sphinx

The Sphinx documentation generator.

Source Code:

github.com/sphinx-doc/sphinx/

Package:

pypi.org/project/sphinx/

Documentation:

www.sphinx-doc.org/

Test Reporter

Displays test results from popular testing frameworks directly in GitHub.

Source Code:

github.com/dorny/test-reporter/

Marketplace:

github.com/marketplace/actions/test-reporter/

README:

github.com/dorny/test-reporter → README.md

upload-artifact

GitHub Action uploading artifacts within a workflow run. GitHub: pyTooling/upload-artifact wraps GitHub: actions/upload-artifact and packs the uploaded files into a tarball first, because the original action does not preserve file modes and symbolic links.

Source Code:

github.com/pyTooling/upload-artifact/

Marketplace:

github.com/marketplace/actions/pytooling-upload-artifact/

twine

Utilities for interacting with PyPI.

Source Code:

github.com/pypa/twine/

Package:

pypi.org/project/twine/

Documentation:

twine.readthedocs.io/

wheel

Reference implementation of the Python wheel packaging standard. It is installed alongside pip by most job templates, because a source distribution that has to be built during installation needs it.

Source Code:

github.com/pypa/wheel/

Package:

pypi.org/project/wheel/

Documentation:

wheel.readthedocs.io/