List of tools - NotANameServer/incipyt GitHub Wiki

Quasi-standard de facto tools

• Virtual environment
  • venv
  • Virtualenv
  • Simple Python Version Management: pyenv
  • Pew - Python Env Wrapper
• git
• Packaging Python Projects
  • twine
  • setuptools
  • flit
  • hatch
• Dependencies:
  • Poetry
  • Pipenv: Python Development Workflow for Humans
  • PDM - Python Development Master
• Sphinx
  • pydocstyle - docstring style checker
  • doc8
• Tests
  • unittest — Unit testing framework
  • pytest
  • Vulture - Find dead code
  • tox: standardize testing in Python
  • Nox: Flexible test automation
• Black: The Uncompromising Code Formatter
• Linter and checker
  • Flake8: Your Tool For Style Guide Enforcement
  • FlakeHell
  • Pyflakes
  • Pylint
  • Bandit
  • pycodestyle
  • mypy
  • pytype
  • Jedi
  • Pyre
• Shell and Notebook
  • IPython
  • Project Jupyter

Description

Flux operationel

• VCS init:
  • git --fast-version-control

  git init
  git add
  git commit
  git remote add
  

  • Mercurial SCM

  hg init
  hg add
  hg commit
  cat .hg/hgrc
  

  • Apache Subversion
  • Bazaar
• Virtuel env creation
  • venv

  venv.EnvBuilder().create()
  

  • Virtualenv

  virtualenv.cli_run()
  

  • Simple Python Version Management: pyenv

  venv.EnvBuilder().create() #Si venv
  virtualenv.cli_run()       #Si Virtualenv
  

  • Pew - Python Env Wrapper

  pew new
  

  • Poetry

  poetry init
  

  • Pipenv: Python Development Workflow for Humans

  pipenv install
  

  • Hatch

  hatch env create
  

• Dependencies management:
  • Poetry

  cat pyproject.toml
  

  • Pipenv: Python Development Workflow for Humans

  pipenv install
  

• Classifier PEP301
  • trove-classifiers

  pip install trove-classifiers
  cat pyproject.toml
  

• Changelog
  • keep a changelog
• Formater:
  • Black: The Uncompromising Code Formatter

  pip install black
  cat pyproject.toml
  

• Analysers:
  • Check PEP8
    • Flake8: Your Tool For Style Guide Enforcement

    pip install flake8
    pip install pyproject-flake8 #Temporaire
    pip install flake8-bugbear #Optionnel
    cat .flake8
    cat setup.cfg
    cat tox.ini
    cat pyproject.toml #pyproject-flake8 
    

    • pycodestyle

    pip install pycodestyle
    cat setup.cfg
    cat tox.ini
    

    • FlakeHell

    pip install flakehell
    pip install flake8-bugbear #Optionnel
    cat pyproject.toml
    

    • Pylint

    pip install pylint
    cat pylintrc
    cat .pylintrc
    cat pyproject.toml
    cat setup.cfg
    

  • Static analysis
    • Pylint

    pip install pylint
    cat pylintrc
    cat .pylintrc
    cat pyproject.toml
    cat setup.cfg
    

    • Pyflakes

    pip install pyflakes
    

    • Jedi

    pip install jedi
    

    • Bandit
    • Pyre
  • Type analyseur
    • mypy

    pip install mypy
    cat mypy.ini
    cat .mypy.ini
    cat setup.cfg
    

    • pytype
• Tests:
  • Unitaires et cas d'usage
    • unittest — Unit testing framework
    • nose2

    pip install nose2
    cat unittest.cfg 
    cat nose2.cfg
    cat pyproject.toml #Issue 452
    

    • pytest

    pip install pytest
    cat pytest.ini
    cat pyproject.toml
    cat tox.ini
    cat setup.cfg
    

    • Ward: A testing framework for Python 3.6 and beyond

    pip install ward
    cat pyproject.toml
    

    • doctest — Test interactive Python examples
  • Performances
    • pytest-benchmark

    pip install pytest-benchmark
    cat pytest.ini
    cat pyproject.toml
    cat tox.ini
    cat setup.cfg
    

  • Coverage
    • nose2

    pip install nose2[coverage_plugin]
    cat unittest.cfg 
    cat nose2.cfg
    cat pyproject.toml #Issue 452
    

    • pytest-cov

    pip install pytest-cov
    cat pytest.ini
    cat pyproject.toml
    cat tox.ini
    cat setup.cfg
    

    • Vulture - Find dead code

    pip install vulture
    cat pyproject.toml
    

  • Automation
    • tox: standardize testing in Python

    pip install tox
    pip install tox-pyenv #Optionnel
    cat pyproject.toml
    cat tox.ini
    cat setup.cfg
    

    • Nox: Flexible test automation

    pip install nox
    pip install nox-poetry #Optionnel
    cat noxfile.py
    

• Documentation:
  • Checker PEP257
    • pydocstyle - docstring style checker

    pip install pydocstyle
    cat setup.cfg
    cat tox.ini
    cat .pydocstyle
    cat .pydocstyle.ini
    cat .pydocstylerc
    cat .pydocstylerc.ini
    

  • Checker .rst
    • doc8

    pip install doc8
    cat doc8.ini
    cat tox.ini
    cat pep8.ini
    cat setup.cfg
    cat pyproject.toml #commit adfd81728964cea41554de0cd664a9c16b6081d3
    

  • Production
    • Sphinx

    pip install sphinx
    pip install breathe m2r2 sphinx-rtd-theme sphinxcontrib-apidoc #Optionnel
    sphinx-quickstart
    cat conf.py
    

  • Deployment
    • Read the Docs: Documentation Simplified

    cat .readthedocs.yaml
    

• Automatic hooks
  • pre-commit: A framework for managing and maintaining multi-language pre-commit hooks.

  pip install pre-commit
  cat .pre-commit-config.yaml
  

• Deployment -- Packaging Python Projects:
  • Compilation:
    • setuptools

    cat setup.cfg
    cat pyproject.toml
    

    • Poetry

    cat pyproject.toml
    

  • Packaging
    • setuptools

    cat setup.cfg
    cat pyproject.toml
    

    • Poetry

    cat pyproject.toml
    

    • flit

    pip install flit
    cat pyproject.toml
    

    • Hatch

    pip install hatch
    cat pyproject.toml
    

  • Deployment
    • twine

    pip install twine
    

    • Poetry

    cat pyproject.toml
    

    • flit

    pip install flit
    cat pyproject.toml
    

    • Hatch

    pip install hatch
    cat pyproject.toml