tox.ini

[tox]

envlist =
  # Envs to build
  {linux, darwin, win32}-{py39}-{build}-{pyqt5,pyside2}
  # Envs for metrics and development
  {linux}-{py39}-{lint}
  {linux}-{py39}-{safety}
  {linux}-{py39}-{metric}
  {linux}-{py39}-{doc}
  {linux}-{py39}-{release}


skip_missing_interpreters =
  true

[gh-actions]
python =
    3.9: py39

[gh-actions:env]
PLATFORM =
    ubuntu-latest: linux
    macos-latest: darwin
    windows-latest: win32

TASK =
    build: build
    lint: lint
    safety: safety
    metric: metric
    doc: doc
    release: release

[testenv]

platform =
  # platforms to run
  win: win32
  lin: linux
  mac: osx

deps =
  build: -rreq-stable.txt
  test: -rreq-test.txt
  lint: -rreq-test.txt
  safety: -rreq-test.txt
  metric: -rreq-test.txt
  doc: -rreq-doc.txt
  release: -rreq-release.txt

  # basic dependencies for each env
  pyqt: pyqt4
  pyqt5: pyqt5
  pyside: pyside
  pyside2: pyside2

whitelist_externals =
  # non python dependencies
  qmake
  doc: make
  doc: latexpdf

changedir=
  doc: docs

commands =
  python -m pip install --upgrade pip

  # check depedencies
  pip check
  # list all deps
  pip list

  # BUILD ------------------------------------------------------------------

  # try generate build
  build: python setup.py sdist bdist_wheel
  # try install with pip
  build: pip install .
  # get some info
  build: python -m qrainbowstyle --all

  # need to run the interface to certify the build, run example
  build-pyqt5: python example/example.py --qt_from=pyqt5 --test

  build-pyside2: python example/example.py --qt_from=pyside2 --test

  # TEST -------------------------------------------------------------------

  # Those commands commented below correct style problems
  # DO NOT RUN ON SERVER, it is just to keep registry for local use
  # autopep8 --ignore=E501 --aggressive --aggressive --aggressive --experimental
  # docformatter -r -i --wrap-summaries=0 --wrap-descriptions=0 *.py
  # eradicate

  # Test and coverage
  # test: pytest --cov "./tests"
  test: pytest --cov

  # Code and docstring style check, running alone for now - pylama-#156
  # test: pylama -v --options="tox.ini" "{toxinidir}"

  # Code linting
  lint: pycodestyle --config="tox.ini" "."
  # lint: pyflakes "./qrainbowstyle"
  # lint: mypy --config-file="tox.ini" "qrainbowstyle"

  # Code and doc linting
  lint: pylint -r y --rcfile="pylint.ini" "./qrainbowstyle" --disable="R1260,R0912" --exit-zero

  # Doc linting
  lint: pydocstyle --config="tox.ini" "."
  lint: doc8 --ignore="D002,D004" --config="tox.ini" "."

  # Safety
  safety: safety check
  safety: bandit --recursive qrainbowstyle

  # Code metrics
  metric: radon cc -a qrainbowstyle --exclude="*/ui/*" --exclude="*/styles/*"
  metric: radon mi qrainbowstyle --exclude="*/ui/*" --exclude="*/styles/*"
  metric: radon raw -s qrainbowstyle --exclude="*/ui/*" --exclude="*/styles/*"
  metric: radon hal -f qrainbowstyle --exclude="*/ui/*" --exclude="*/styles/*"

  # DOC (inside docs folder) ----------------------------------------------

  # Documentation - generate apidocs, build html, build latex, build pdf
  doc: sphinx-apidoc --private --separate --force --module-first -o "example" "{toxworkdir}/../example" "{toxworkdir}/../example/ui/*"
  doc: sphinx-apidoc --private --separate --force --module-first -o "reference" "{toxworkdir}/../qrainbowstyle"
  doc: sphinx-apidoc --private --separate --force --module-first -o "scripts" "{toxworkdir}/../scripts"
  
  doc: sphinx-build -b html -j auto -E -d "{toxworkdir}/../build/docs/doctrees" . "{toxworkdir}/../build/docs/html"

  # RELEASE -------------------------------------------------------------------------------
  # Try to use re-ver package
  release: python setup.py clean --all
  release: python setup.py sdist bdist_wheel
  release: python setup.py check -s -r # even deprecated, shows better error messages that are passing in twine
  release: twine check dist/*


usedevelop =
  develop: true


# PYCODESTYLE ################################################################

[pycodestyle]

ignore = E501,C0301,W503,W504 # Issue: in travis shows W504, local W503 the same line
max-line-length = 150
statistics = True
count = True
exclude =
    .tox,.env,.venv,build,dist,tests,examples,ui,*.egg-info*,*cache*,.coverage,
    */.tox/*,*/.env/*,*/.venv/*,*/build/*,*/dist/*,*/tests/*,*/ui/*,*/*.egg*,
    */.*,*/.coverage,*/./venv/*,./venv,*/docs/*,docs,venv,
    style_rc.py,mw_for_ui_tests.py,test.py

# PYDOCSTYLE #################################################################

[pydocstyle]

ignore = D107,D200,D202,D203,D212,D213,D406,D407,D413
match-dir = "[^\.].*,!(docs),!(venv)"
match = "!style_rc.py"

# DOC8 #######################################################################

[doc8]

extension = .rst
ignore = D002,D004 # problems in Windows fyle system, issue. Also, it just works with the first ignored code
max-line-length = 150
file-encoding = "utf-8"
ignore-path =
    .tox,.env,.venv,build,dist,tests,examples,ui,*.egg-info*,*cache*,.coverage,
    */.tox/*,*/.env/*,*/.venv/*,*/build/*,*/dist/*,*/tests/*,*/ui/*,*/*.egg*,
    */.*,*/.coverage,*/./venv/*,./venv

# PYLAMA #####################################################################

[pylama]

format = pylint
linters = pyflakes
skip =
    .tox,.env,.venv,build,dist,tests,examples,ui,*.egg-info*,*cache*,.coverage,
    */.tox/*,*/.env/*,*/.venv/*,*/build/*,*/dist/*,*/tests/*,*/ui/*,*/*.egg*,
    */.*,*/.coverage,*/./venv/*,./venv,venv

# MYPY #######################################################################

[mypy]
# general configuration

[mypy-numpy]
ignore_missing_imports = True

[mypy-qtpy]
ignore_missing_imports = True

[mypy-scipy]
ignore_missing_imports = True

[mypy-pint]
ignore_missing_imports = True

[mypy-pyqtgraph]
ignore_missing_imports = True

[mypy-spyder]
ignore_missing_imports = True

[mypy-networkx]
ignore_missing_imports = True

[mypy-qrainbowstyle]
ignore_missing_imports = True

[mypy-jsonpickle]
ignore_missing_imports = True