clean up tasks

requirements-dev.txt

@@ -1,7 +1,7 @@
 attrs >=17.4
 black >=22.12.0
 bump-my-version
-compas_invocations
+compas_invocations2
 compas_notebook
 invoke >=0.14
 ruff

tasks.py

@@ -1,194 +1,33 @@
-import glob
-import os
-import shutil
-import invoke
-from invoke import Collection
-
-from compas_invocations import build
-from compas_invocations import docs as docs_
-from compas_invocations import tests
-from compas_invocations.console import chdir
-from compas_invocations.console import confirm
-
-
-@invoke.task(
-    help={
-        "docs": "True to clean up generated documentation, otherwise False",
-        "bytecode": "True to clean up compiled python files, otherwise False.",
-        "builds": "True to clean up build/packaging artifacts, otherwise False.",
-    }
-)
-def clean(ctx, docs=True, bytecode=True, builds=True, ghuser=True):
-    """Cleans the local copy from compiled artifacts."""
-
-    with chdir(ctx.base_folder):
-        if bytecode:
-            for root, dirs, files in os.walk(ctx.base_folder):
-                for f in files:
-                    if f.endswith(".pyc"):
-                        os.remove(os.path.join(root, f))
-                if ".git" in dirs:
-                    dirs.remove(".git")
-
-        folders = []
-
-        if docs:
-            folders.append("docs/api/generated")
-
-        folders.append("dist/")
-
-        if bytecode:
-            for t in ("src", "tests"):
-                folders.extend(glob.glob("{}/**/__pycache__".format(t), recursive=True))
-
-        if builds:
-            folders.append("build/")
-            folders.extend(glob.glob("src/**/*.egg-info", recursive=False))
-
-        if ghuser and ctx.get("ghuser"):
-            folders.append(os.path.abspath(ctx.ghuser.target_dir))
-
-        for folder in folders:
-            shutil.rmtree(os.path.join(ctx.base_folder, folder), ignore_errors=True)
-
-
-@invoke.task()
-def lint(ctx):
-    """Check the consistency of coding style."""
-
-    print("\nRunning ruff linter...")
-    ctx.run("ruff check --fix src tests")
-
-    print("\nRunning black linter...")
-    ctx.run("black --check --diff --color src tests")
-
-    print("\nAll linting is done!")
-
-
-@invoke.task()
-def format(ctx):
-    """Reformat the code base using black."""
-
-    print("\nRunning ruff formatter...")
-    ctx.run("ruff format src tests")
-
-    print("\nRunning black formatter...")
-    ctx.run("black src tests")
-
-    print("\nAll formatting is done!")
-
+from __future__ import print_function
 
-@invoke.task()
-def check(ctx):
-    """Check the consistency of documentation, coding style and a few other things."""
-
-    with chdir(ctx.base_folder):
-        lint(ctx)
-
-
-@invoke.task(
-    help={
-        "rebuild": "True to clean all previously built docs before starting, otherwise False.",
-        "doctest": "True to run doctests, otherwise False.",
-        "check_links": "True to check all web links in docs for validity, otherwise False.",
-    }
-)
-def docs(ctx, doctest=False, rebuild=False, check_links=False):
-    """Builds the HTML documentation."""
-
-    if rebuild:
-        clean(ctx)
-
-    with chdir(ctx.base_folder):
-        if doctest:
-            ctx.run("pytest --doctest-modules")
-
-        opts = "-E" if rebuild else ""
-        ctx.run("sphinx-build {} -b html docs dist/docs".format(opts))
-
-        if check_links:
-            linkcheck(ctx, rebuild=rebuild)
-
-
-@invoke.task()
-def linkcheck(ctx, rebuild=False):
-    """Check links in documentation."""
-    print("Running link check...")
-    opts = "-E" if rebuild else ""
-    ctx.run("sphinx-build {} -b linkcheck docs dist/docs".format(opts))
-
-
-@invoke.task(help={"release_type": "Type of release follows semver rules. Must be one of: major, minor, patch."})
-def release(ctx, release_type):
-    """Releases the project in one swift command!"""
-    if release_type not in ("patch", "minor", "major"):
-        raise invoke.Exit("The release type parameter is invalid.\nMust be one of: major, minor, patch.")
-
-    # Run formatter
-    ctx.run("invoke format")
-
-    # Run checks
-    ctx.run("invoke test")
-
-    # Bump version and git tag it
-    ctx.run("bump-my-version bump %s --verbose" % release_type)
-
-    # Build project
-    ctx.run("python -m build")
-
-    # Prepare the change log for the next release
-    prepare_changelog(ctx)
-
-    # Clean up local artifacts
-    clean(ctx)
-
-    # Upload to pypi
-    if confirm(
-        "Everything is ready. You are about to push to git which will trigger a release to pypi.org. Are you sure?",
-        assume_yes=False,
-    ):
-        ctx.run("git push --tags && git push")
-    else:
-        raise invoke.Exit("You need to manually revert the tag/commits created.")
-
-
-@invoke.task
-def prepare_changelog(ctx):
-    """Prepare changelog for next release."""
-    UNRELEASED_CHANGELOG_TEMPLATE = "## Unreleased\n\n### Added\n\n### Changed\n\n### Removed\n\n\n## "
-
-    with chdir(ctx.base_folder):
-        # Preparing changelog for next release
-        with open("CHANGELOG.md", "r+") as changelog:
-            content = changelog.read()
-            changelog.seek(0)
-            changelog.write(content.replace("## ", UNRELEASED_CHANGELOG_TEMPLATE, 1))
-
-        ctx.run('git add CHANGELOG.md && git commit -m "Prepare changelog for next release"')
+import os
 
+from compas_invocations2 import build
+from compas_invocations2 import docs
+from compas_invocations2 import style
+from compas_invocations2 import tests
+from invoke import Collection
 
 ns = Collection(
-    docs_.help,
-    check,
-    lint,
-    format,
-    docs,
-    linkcheck,
+    docs.help,
+    style.check,
+    style.lint,
+    style.format,
+    docs.docs,
+    docs.linkcheck,
     tests.test,
     tests.testdocs,
-    tests.testcodeblocks,
-    prepare_changelog,
-    clean,
-    release,
     build.build_ghuser_components,
+    build.prepare_changelog,
+    build.clean,
+    build.release,
 )
 ns.configure(
     {
         "base_folder": os.path.dirname(__file__),
         "ghuser": {
-            "source_dir": "src/compas_ghpython/components",
-            "target_dir": "src/compas_ghpython/components/ghuser",
-            "prefix": "COMPAS: ",
+            "source_dir": "src/compas_notebook/ghpython/components",
+            "target_dir": "src/compas_notebook/ghpython/components/ghuser",
         },
     }
 )