tasktree 0.0.3__tar.gz → 0.0.5__tar.gz

{tasktree-0.0.3 → tasktree-0.0.5}/.gitignore

@@ -80,9 +80,6 @@ target/
 profile_default/
 ipython_config.py
 
-# pyenv
-.python-version
-
 # pipenv
 Pipfile.lock
 

tasktree-0.0.5/.python-version

@@ -0,0 +1 @@
+3.12

{tasktree-0.0.3 → tasktree-0.0.5}/CLAUDE.md

@@ -58,12 +58,13 @@ The project uses Python's built-in `unittest` framework with mocking via `unitte
 
 Tasks are defined in YAML with the following structure:
 ```yaml
-task-name:
-  desc: Description (optional)
-  deps: [dependency-tasks]
-  inputs: [glob-patterns]
-  outputs: [glob-patterns]
-  working_dir: execution-directory
-  args: [typed-parameters]
-  cmd: shell-command
+tasks:
+  task-name:
+    desc: Description (optional)
+    deps: [dependency-tasks]
+    inputs: [glob-patterns]
+    outputs: [glob-patterns]
+    working_dir: execution-directory
+    args: [typed-parameters]
+    cmd: shell-command
 ```

{tasktree-0.0.3 → tasktree-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tasktree
-Version: 0.0.3
+Version: 0.0.5
 Summary: A task automation tool with incremental execution
 Requires-Python: >=3.11
 Requires-Dist: click>=8.1.0
@@ -18,6 +18,142 @@ Description-Content-Type: text/markdown
 
 A task automation tool that combines simple command execution with dependency tracking and incremental execution.
 
+## Motivation
+In any project of even moderate size, various scripts inevitably come into being along the way. These scripts often must be run in a particular order, or at a particular time. For historical reasons, this almost certainly a problem if your project is developed in a Linux environment; in Windows, an IDE like Visual Studio may be taking care of a significant proportion of your build, packaging and deployment tasks. Then again, it may not...
+
+The various incantations that have to be issued to build, package, test and deploy a project can build up and then all of a sudden there's only a few people that remember which to invoke and when and then people start making helpful readme guides on what to do with the scripts and then those become out of date and start telling lies about things and so on.
+
+Then there's the scripts themselves. In Linux, they're probably a big pile of Bash and Python, or something (Ruby, Perl, you name it). You can bet the house on people solving the problem of passing parameters to their scripts in a whole bunch of different and inconsistent ways.
+
+```bash
+#!/usr/bin/env bash
+# It's an environment variable defined.... somewhere?
+echo "FOO is: $FOO"
+```
+```bash
+#!/usr/bin/env bash
+# Using simple positional arguments... guess what means what when you're invoking it!
+echo "First: $1, Second: $2"
+```
+```bash
+#!/usr/bin/env bash
+# Oooooh fancy "make me look like a proper app" named option parsing... don't try and do --foo=bar though!
+FOO=""
+while [[ $# -gt 0 ]]; do
+    case "$1" in
+        --foo) FOO=$2; shift ;;
+        --)    break ;;
+        *)     echo "Unknown: $1";;
+    esac
+    shift
+done
+```
+```bash
+#!/usr/bin/env bash
+# This thing...
+ARGS=$(getopt -o f:b --long foo:,bar: -n 'myscript' -- "$@")
+eval set -- "$ARGS"
+while true; do
+    case "$1" in
+        -b|--bar) echo "Bar: $2"; shift 2 ;;
+        -f|--foo) echo "Foo: $2"; shift 2 ;;
+        --) shift; break ;;
+        *) break ;;
+    esac
+done
+```
+
+What about help info? Who has time to wire that in?
+
+### The point
+Is this just whining and moaning? Should we just man up and revel in our own ability to memorize all the right incantations like some kind of scripting shaman?
+
+... No. That's **a dumb idea**.
+
+Task Tree allows you to pile all the knowledge of **what** to run, **when** to run it, **where** to run it and **how** to run it into a single, readable place. Then you can delete all the scripts that no-one knows how to use and all the readme docs that lie to the few people that actually waste their time reading them.
+
+The tasks you need to perform to deliver your project become summarised in an executable file that looks like:
+```yaml
+tasks:
+  build:
+    desc: Compile stuff
+    outputs: [target/release/bin]
+    cmd: cargo build --release
+
+  package:
+     desc: build installers
+     deps: [build]
+     outputs: [awesome.deb]
+     cmd: |
+        for bin in target/release/*; do
+            if [[ -x "$bin" && ! -d "$bin" ]]; then
+                install -Dm755 "$bin" "debian/awesome/usr/bin/$(basename "$bin")"
+            fi
+        done
+
+        dpkg-buildpackage -us -uc
+
+  test:
+    desc: Run tests
+    deps: [package]
+    inputs: [tests/**/*.py]
+    cmd: PYTHONPATH=src python3 -m pytest tests/ -v
+```
+
+If you want to run the tests then:
+```bash
+tt test
+```
+Boom! Done. `build` will always run, because there's no sensible way to know what Cargo did. However, if Cargo decided that nothing needed to be done and didn't touch the binaries, then `package` will realize that and not do anything. Then `test` will just run with the new tests that you just wrote. If you then immediately run `test` again, then `test` will figure out that none of the dependencies did anything and that none of the test files have changed and then just _do nothing_ - as it should.
+
+This is a toy example, but you can image how it plays out on a more complex project.
+
+## Migrating from v1.x to v2.0
+
+Version 2.0 requires all task definitions to be under a top-level `tasks:` key.
+
+### Quick Migration
+
+Wrap your existing tasks in a `tasks:` block:
+
+```yaml
+# Before (v1.x)
+build:
+  cmd: cargo build
+
+# After (v2.0)
+tasks:
+  build:
+    cmd: cargo build
+```
+
+### Why This Change?
+
+1. **Clearer structure**: Explicit separation of tasks from configuration
+2. **No naming conflicts**: You can now create tasks named "imports" or "environments"
+3. **Better error messages**: More helpful validation errors
+4. **Consistency**: All recipe files use the same format
+
+### Error Messages
+
+If you forget to update, you'll see a clear error:
+
+```
+Invalid recipe format in tasktree.yaml
+
+Task definitions must be under a top-level "tasks:" key.
+
+Found these keys at root level: build, test
+
+Did you mean:
+
+tasks:
+  build:
+    cmd: ...
+  test:
+    cmd: ...
+```
+
 ## Installation
 
 ### From PyPI (Recommended)
@@ -26,6 +162,16 @@ A task automation tool that combines simple command execution with dependency tr
 pipx install tasktree
 ```
 
+If you have multiple Python interpreter versions installed, and the _default_ interpreter is a version <3.11, then you can use `pipx`'s `--python` option to specify an interpreter with a version >=3.11:
+
+```bash
+# If the target version is on the PATH
+pipx install --python python3.12 tasktree
+
+# With a path to an interpreter
+pipx install --python /path/to/python3.12 tasktree
+```
+
 ### From Source
 
 For the latest unreleased version from GitHub:
@@ -47,23 +193,26 @@ pipx install .
 Create a `tasktree.yaml` (or `tt.yaml`) in your project:
 
 ```yaml
-build:
-  desc: Compile the application
-  outputs: [target/release/bin]
-  cmd: cargo build --release
+tasks:
+  build:
+    desc: Compile the application
+    outputs: [target/release/bin]
+    cmd: cargo build --release
 
-test:
-  desc: Run tests
-  deps: [build]
-  cmd: cargo test
+  test:
+    desc: Run tests
+    deps: [build]
+    cmd: cargo test
 ```
 
 Run tasks:
 
 ```bash
-tt build          # Build the application
-tt test           # Run tests (builds first if needed)
+tt                # Print the help
+tt --help         # ...also print the help
 tt --list         # Show all available tasks
+tt build          # Build the application (assuming this is in your tasktree.yaml)
+tt test           # Run tests (builds first if needed)
 ```
 
 ## Core Concepts
@@ -84,15 +233,16 @@ Task Tree only runs tasks when necessary. A task executes if:
 Tasks automatically inherit inputs from dependencies, eliminating redundant declarations:
 
 ```yaml
-build:
-  outputs: [dist/app]
-  cmd: go build -o dist/app
-
-package:
-  deps: [build]
-  outputs: [dist/app.tar.gz]
-  cmd: tar czf dist/app.tar.gz dist/app
-  # Automatically tracks dist/app as an input
+tasks:
+  build:
+    outputs: [dist/app]
+    cmd: go build -o dist/app
+
+  package:
+    deps: [build]
+    outputs: [dist/app.tar.gz]
+    cmd: tar czf dist/app.tar.gz dist/app
+    # Automatically tracks dist/app as an input
 ```
 
 ### Single State File
@@ -104,15 +254,16 @@ All state lives in `.tasktree-state` at your project root. Stale entries are aut
 ### Basic Structure
 
 ```yaml
-task-name:
-  desc: Human-readable description (optional)
-  deps: [other-task]                     # Task dependencies
-  inputs: [src/**/*.go]                  # Explicit input files (glob patterns)
-  outputs: [dist/binary]                 # Output files (glob patterns)
-  working_dir: subproject/               # Execution directory (default: project root)
-  env: bash-strict                       # Execution environment (optional)
-  args: [param1, param2:path=default]    # Task parameters
-  cmd: go build -o dist/binary           # Command to execute
+tasks:
+  task-name:
+    desc: Human-readable description (optional)
+    deps: [other-task]                     # Task dependencies
+    inputs: [src/**/*.go]                  # Explicit input files (glob patterns)
+    outputs: [dist/binary]                 # Output files (glob patterns)
+    working_dir: subproject/               # Execution directory (default: project root)
+    env: bash-strict                       # Execution environment (optional)
+    args: [param1, param2:path=default]    # Task parameters
+    cmd: go build -o dist/binary           # Command to execute
 ```
 
 ### Commands
@@ -120,18 +271,20 @@ task-name:
 **Single-line commands** are executed directly via the configured shell:
 
 ```yaml
-build:
-  cmd: cargo build --release
+tasks:
+  build:
+    cmd: cargo build --release
 ```
 
 **Multi-line commands** are written to temporary script files for proper execution:
 
 ```yaml
-deploy:
-  cmd: |
-    mkdir -p dist
-    cp build/* dist/
-    rsync -av dist/ server:/opt/app/
+tasks:
+  deploy:
+    cmd: |
+      mkdir -p dist
+      cp build/* dist/
+      rsync -av dist/ server:/opt/app/
 ```
 
 Multi-line commands preserve shell syntax (line continuations, heredocs, etc.) and support shebangs on Unix/macOS.
@@ -139,12 +292,13 @@ Multi-line commands preserve shell syntax (line continuations, heredocs, etc.) a
 Or use folded blocks for long single-line commands:
 
 ```yaml
-compile:
-  cmd: >
-    gcc -o bin/app
-    src/*.c
-    -I include
-    -L lib -lm
+tasks:
+  compile:
+    cmd: >
+      gcc -o bin/app
+      src/*.c
+      -I include
+      -L lib -lm
 ```
 
 ### Execution Environments
@@ -204,12 +358,13 @@ tasks:
 Tasks can accept arguments with optional defaults:
 
 ```yaml
-deploy:
-  args: [environment, region=eu-west-1]
-  deps: [build]
-  cmd: |
-    aws s3 cp dist/app.zip s3://{{environment}}-{{region}}/
-    aws lambda update-function-code --function-name app-{{environment}}
+tasks:
+  deploy:
+    args: [environment, region=eu-west-1]
+    deps: [build]
+    cmd: |
+      aws s3 cp dist/app.zip s3://{{environment}}-{{region}}/
+      aws lambda update-function-code --function-name app-{{environment}}
 ```
 
 Invoke with: `tt deploy production` or `tt deploy staging us-east-1` or `tt deploy staging region=us-east-1`. 
@@ -236,18 +391,19 @@ Split task definitions across multiple files for better organisation:
 
 ```yaml
 # tasktree.yaml
-import:
+imports:
   - file: build/tasks.yml
     as: build
   - file: deploy/tasks.yml
     as: deploy
 
-test:
-  deps: [build.compile, build.test-compile]
-  cmd: ./run-tests.sh
+tasks:
+  test:
+    deps: [build.compile, build.test-compile]
+    cmd: ./run-tests.sh
 
-ci:
-  deps: [build.all, test, deploy.staging]
+  ci:
+    deps: [build.all, test, deploy.staging]
 ```
 
 Imported tasks are namespaced and can be referenced as dependencies. Each imported file is self-contained—it cannot depend on tasks in the importing file.
@@ -365,41 +521,42 @@ imports:
   - file: common/docker.yml
     as: docker
 
-compile:
-  desc: Build application binaries
-  outputs: [target/release/app]
-  cmd: cargo build --release
-
-test-unit:
-  desc: Run unit tests
-  deps: [compile]
-  cmd: cargo test
-
-package:
-  desc: Create distribution archive
-  deps: [compile]
-  outputs: [dist/app-{{version}}.tar.gz]
-  args: [version]
-  cmd: |
-    mkdir -p dist
-    tar czf dist/app-{{version}}.tar.gz \
-      target/release/app \
-      config/ \
-      migrations/
-
-deploy:
-  desc: Deploy to environment
-  deps: [package, docker.build-runtime]
-  args: [environment, version]
-  cmd: |
-    scp dist/app-{{version}}.tar.gz {{environment}}:/opt/
-    ssh {{environment}} /opt/deploy.sh {{version}}
-
-integration-test:
-  desc: Run integration tests against deployed environment
-  deps: [deploy]
-  args: [environment, version]
-  cmd: pytest tests/integration/ --env={{environment}}
+tasks:
+  compile:
+    desc: Build application binaries
+    outputs: [target/release/app]
+    cmd: cargo build --release
+
+  test-unit:
+    desc: Run unit tests
+    deps: [compile]
+    cmd: cargo test
+
+  package:
+    desc: Create distribution archive
+    deps: [compile]
+    outputs: [dist/app-{{version}}.tar.gz]
+    args: [version]
+    cmd: |
+      mkdir -p dist
+      tar czf dist/app-{{version}}.tar.gz \
+        target/release/app \
+        config/ \
+        migrations/
+
+  deploy:
+    desc: Deploy to environment
+    deps: [package, docker.build-runtime]
+    args: [environment, version]
+    cmd: |
+      scp dist/app-{{version}}.tar.gz {{environment}}:/opt/
+      ssh {{environment}} /opt/deploy.sh {{version}}
+
+  integration-test:
+    desc: Run integration tests against deployed environment
+    deps: [deploy]
+    args: [environment, version]
+    cmd: pytest tests/integration/ --env={{environment}}
 ```
 
 Run the full pipeline: