noxfile.py

from pathlib import Path

import nox  # type: ignore

python = ["3.10"]
nox.options.sessions = ["lint"]
nox.options.reuse_existing_virtualenvs = True

doc_deps = [".", "jinja2", "mkdocs", "mkdocs-material"]
dev_deps = ["mypy", "black"]
lint_deps = ["black", "flake8", "flake8-bugbear", "mypy", "check-manifest"]
test_deps = [
    "pytest",
    # required by FastAPI's test code
    "requests",
    "psutil",
]


@nox.session(python=python)
def serve(session):
    """Install and run termpair serve <posargs>"""
    print("Note: Frontend must be built for this to work")
    session.install("-e", ".")
    session.run("termpair", "serve", *session.posargs)


@nox.session(python=python)
def share(session):
    """Install and run 'termpair share <posargs>'"""
    print("Note: Frontend must be built for this to work")
    session.install("-e", ".")
    session.run("termpair", "share", *session.posargs)


@nox.session(python=python)
def watch_docs(session):
    """Build mkdocs, run server, and watch for changes"""
    session.install(*doc_deps)
    session.run("mkdocs", "serve")


@nox.session(python=python)
def build_frontend(session):
    session.run("yarn", "--cwd", "termpair/frontend_src", "install", external=True)
    session.run("yarn", "--cwd", "termpair/frontend_src", "build", external=True)


@nox.session(python=python)
def build_executable(session):
    """Builds a pex of termpair"""
    session.install("pex==2.1.93")
    session.run(
        "pex",
        ".",
        "--console-script",
        "termpair",
        "--output-file",
        "build/termpair.pex",
        "--sh-boot",
        "--validate-entry-point",
        external=True,
    )


@nox.session()
def publish_docs(session):
    """Run mkdocs gh-deploy"""
    session.install(*doc_deps)
    session.run("mkdocs", "gh-deploy")


@nox.session()
def publish_static_webapp(session):
    """Build frontend and publish to github pages"""
    build_frontend(session)
    session.run("git", "checkout", "gh-pages", external=True)
    session.run("rm", "-rf", "connect/", external=True)
    session.run("mkdir", "connect", external=True)
    session.run("cp", "-rT", "termpair/frontend_build/", "connect/", external=True)
    session.run("git", "add", "connect", external=True)
    session.run("git", "commit", "-m", "commit built frontend", external=True)
    session.run("git", "push", "origin", "gh-pages", external=True)


@nox.session()
def publish(session):
    """Build+Publish to PyPI, docs, and static webapp"""
    print("REMINDER: Has the changelog been updated?")
    session.run("rm", "-rf", "dist", "build", external=True)
    publish_deps = ["setuptools", "wheel", "twine"]
    session.install(*publish_deps)
    session.run("make", "build_frontend", external=True)
    session.run("python", "setup.py", "--quiet", "sdist", "bdist_wheel")
    session.run("python", "-m", "twine", "upload", "dist/*")
    publish_docs(session)
    publish_static_webapp(session)


@nox.session(python=python)
def lint(session):
    """Run all lint checks"""
    session.install(*lint_deps)
    files = ["termpair", "tests"] + [str(p) for p in Path(".").glob("*.py")]
    session.run("black", "--check", *files)
    session.run("flake8", *files)
    session.run("mypy", *files)
    session.run("check-manifest")
    session.run("python", "setup.py", "check", "--metadata", "--strict")


@nox.session(python=[python])
def test(session):
    """Run unit tests"""
    session.install(".", *test_deps)
    # can't use default capture method because termpair requires stdin to have a fileno()
    session.run("pytest", "tests", "--capture", "tee-sys", *session.posargs)


@nox.session(python=[python])
def termpair(session):
    """Install termapir and run it with args passed with -- arg1 arg2"""
    session.install("-e", ".")
    session.run("termpair", *session.posargs)