Glossary
########

.. glossary::

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

     :Source Code:   `https://github.com/PyCQA/bandit/`__
     :Package:       `https://pypi.org/project/bandit/`__
     :Documentation: `https://bandit.readthedocs.io/`__

   build
     A simple, correct Python build frontend.

     :Source Code:   `https://github.com/pypa/build/`__
     :Package:       `https://pypi.org/project/build/`__
     :Documentation: `https://build.pypa.io/`__

   Codacy
     .. todo:: Add description of Codacy.

     :Service:       `Codacy.com <https://www.codacy.com/>`__

   CodeCov
     .. todo:: Add description of CodeCov.

     :Service:       `Codecov.io <https://about.codecov.io/>`__

   Coverage.py
     The code coverage tool for Python.

     :Source Code:   `https://github.com/nedbat/coveragepy/`__
     :Package:       `https://pypi.org/project/coverage/`__
     :Documentation: `https://coverage.readthedocs.io/`__

   delete-artifact
     A GitHub Action to deletes artifacts within the workflow run.

     :Source Code:   `https://github.com/GeekyEggo/delete-artifact/`__
     :Marketplace:   `https://github.com/marketplace/actions/delete-artifact/`__
     :README:        `https://github.com/GeekyEggo/delete-artifact/blob/main/README.md`__

   docstr_coverage
     Docstring coverage analysis and rating for Python.

     :Source Code:   `https://github.com/HunterMcGushion/docstr_coverage/`__
     :Package:       `https://pypi.org/project/docstr_coverage/`__
     :Documentation: `https://docstr-coverage.readthedocs.io/`__

   gh
     GitHub’s official command line tool.

     :Source Code:   `https://github.com/cli/cli/`__
     :Documentation: `https://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:   `https://github.com/econchick/interrogate/`__
     :Package:       `https://pypi.org/project/interrogate/`__
     :Documentation: `https://interrogate.readthedocs.io/`__

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

     :Source Code:   `https://github.com/MiKTeX/miktex/`__
     :Documentation: `https://miktex.org/`__

   mypy
     Optional static typing for Python.

     :Source Code:   `https://github.com/python/mypy/`__
     :Package:       `https://pypi.org/project/mypy/`__
     :Documentation: `https://www.mypy-lang.org/`__

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

     :Source Code:   `https://github.com/edaa-org/pyEDAA.Reports/`__
     :Package:       `https://pypi.org/project/pyEDAA.Reports/`__
     :Documentation: `https://edaa-org.github.io/pyEDAA.Reports/`__

   pip
     The Python package installer.

     :Source Code:   `https://github.com/pypa/pip/`__
     :Package:       `https://pypi.org/project/pip/`__
     :Documentation: `https://pip.pypa.io/`__

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

     :URL:           `PyPI.org <https://pypi.org/>`__

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

     :Source Code:   `https://github.com/pytest-dev/pytest/`__
     :Package:       `https://pypi.org/project/pytest/`__
     :Documentation: `https://pytest.org/`__

   Sphinx
     The Sphinx documentation generator.

     :Source Code:   `https://github.com/sphinx-doc/sphinx/`__
     :Package:       `https://pypi.org/project/sphinx/`__
     :Documentation: `https://www.sphinx-doc.org/`__

   Test Reporter
     Displays test results from popular testing frameworks directly in GitHub.

     :Source Code:   `https://github.com/dorny/test-reporter/`__
     :Marketplace:   `https://github.com/marketplace/actions/test-reporter/`__
     :README:        `https://github.com/dorny/test-reporter/blob/main/README.md`__

   twine
     Utilities for interacting with PyPI.

     :Source Code:   `https://github.com/pypa/twine/`__
     :Package:       `https://pypi.org/project/twine/`__
     :Documentation: `https://twine.readthedocs.io/`__