tasks.py

import webbrowser

from kintree.common.tools import cprint
from invoke import UnexpectedExit, task


@task
def install(c, is_install=True):
    """
    Install Ki-nTree dependencies
    """

    if is_install:
        cprint('[MAIN]\tInstalling required dependencies')
        c.run('pip install -U wheel', hide='out')
    else:
        cprint('[MAIN]\tUpdating required dependencies')
    c.run('pip install -U -r requirements.txt', hide='out')


@task
def update(c):
    """
    Update Ki-nTree dependencies
    """

    install(c, is_install=False)


@task
def clean(c):
    """
    Clean project folder
    """

    cprint('[MAIN]\tCleaning project directory')
    try:
        c.run('find . -name __pycache__ | xargs rm -r', hide='err')
    except UnexpectedExit:
        pass
    try:
        c.run('rm .coverage', hide='err')
    except UnexpectedExit:
        pass
    try:
        c.run('rm .coverage.*', hide='err')
    except UnexpectedExit:
        pass
    try:
        c.run('rm -r dist/ build/ htmlcov', hide='err')
    except UnexpectedExit:
        pass
    

@task(pre=[clean])
def build(c):
    """
    Build Ki-nTree into dist/wheel
    """

    try:
        c.run('pip show poetry', hide=True)
    except UnexpectedExit:
        c.run('pip install -U poetry', hide=True)

    cprint('[MAIN]\tBuilding Ki-nTree GUI into "dist" directory')
    c.run('poetry build', hide=True)


@task
def setup_inventree(c):
    """
    Setup InvenTree server
    """

    c.run('python -m kintree.setup_inventree')


@task
def coverage_report(c, open_browser=True):
    """
    Show coverage report
    """

    cprint('[MAIN]\tBuilding coverage report')
    c.run('coverage report')
    c.run('coverage html')
    if open_browser:
        webbrowser.open('htmlcov/index.html', new=2)


@task
def test(c, enable_api=0):
    """
    Run Ki-nTree tests
    """

    try:
        c.run('pip show coverage', hide=True)
    except UnexpectedExit:
        c.run('pip install -U coverage', hide=True)

    cprint('[MAIN]\tRunning tests using coverage\n-----')
    # Start InvenTree server
    c.run('cd InvenTree/ && inv server && cd ..', asynchronous=True)
    c.run('sleep 15')
    # Copy test files
    c.run('cp -r tests/ kintree/')
    # Run Tests
    run_tests = c.run(f'coverage run run_tests.py {enable_api}')
    if run_tests.exited == 0:
        coverage_report(c, open_browser=False)


@task
def python_badge(c):
    """
    Make badge for supported versions of Python
    """

    cprint('[MAIN]\tInstall pybadges')
    c.run('pip install pybadges pip-autoremove', hide=True)
    cprint('[MAIN]\tCreate badge')
    c.run('python -m pybadges --left-text="python" --right-text="3.9 | 3.10 | 3.11 | 3.12" '
          '--whole-link="https://www.python.org/" --browser --embed-logo '
          '--logo="https://dev.w3.org/SVG/tools/svgweb/samples/svg-files/python.svg"')
    cprint('[MAIN]\tUninstall pybadges')
    c.run('pip-autoremove pybadges -y', hide=True)
    c.run('pip uninstall pip-autoremove -y', hide=True)


@task
def style(c):
    """
    Run PEP style checks against Ki-nTree sourcecode
    """

    c.run('pip install -U flake8', hide=True)
    print("Running PEP style checks...")
    c.run('flake8 --extend-ignore W503 \
        tasks.py run_tests.py kintree_gui.py kintree/kintree_gui.py kintree/setup_inventree.py \
        kintree/common/ kintree/config/ kintree/database/ kintree/kicad/*.py kintree/search/*.py \
        kintree/gui/gui.py kintree/gui/views/*.py')


@task
def gui(c, browser=False):
    """
    Open GUI in either app or browser mode
    """
    if browser:
        c.run('python -m kintree_gui b')
        return
    c.run('python -m kintree_gui')