wrknv Integration¶

How provide-workenv uses wrknv to manage the workspace.

Overview¶

wrknv ("work envy") is the work environment management tool. provide-workenv uses wrknv to coordinate all provide.io repositories.

Think of it as: - wrknv = the tool (like Make or Task) - provide-workenv = a specific configuration (like a Makefile)

What is wrknv?¶

wrknv is a general-purpose work environment manager that: - Manages sibling repositories - Coordinates environment setup - Provides task automation - Handles workspace configuration

See wrknv documentation for complete details.

How provide-workenv Uses wrknv¶

1. Workspace Configuration¶

wrknv.toml defines the workspace structure:

[workspace]
name = "provide-workenv"
description = "provide.io ecosystem workspace manager"

# List all sibling repositories
[[siblings]]
name = "provide-foundation"
path = "../provide-foundation"
repo = "https://github.com/provide-io/provide-foundation.git"

[[siblings]]
name = "provide-testkit"
path = "../provide-testkit"
repo = "https://github.com/provide-io/provide-testkit.git"

[[siblings]]
name = "pyvider"
path = "../pyvider"
repo = "https://github.com/provide-io/pyvider.git"

# ... 13+ total siblings

2. Scripts Use wrknv Configuration¶

The bootstrap script reads wrknv.toml:

# bootstrap.sh (simplified)
# Reads wrknv.toml to find all siblings
for repo in $(parse_wrknv_siblings); do
  if [ ! -d "../$repo" ]; then
    git clone "https://github.com/provide-io/$repo.git" "../$repo"
  fi
done

3. Dependency Detection¶

wrknv can detect sibling repositories automatically:

# wrknv scans parent directory for provide.io packages
wrknv siblings list

# Output:
# provide-foundation  ../provide-foundation
# provide-testkit     ../provide-testkit
# pyvider            ../pyvider
# ...

wrknv.toml Format¶

Full Example¶

[workspace]
name = "provide-workenv"
description = "Workspace manager for the provide.io ecosystem"
version = "0.1.0"

# Python configuration
[workspace.python]
version = ">=3.11"
venv_path = ".venv"

# Development tools
[workspace.tools]
uv = ">=0.1.0"
ruff = ">=0.1.0"
mypy = ">=1.0"

# Sibling repositories (in dependency order)
[[siblings]]
name = "provide-foundation"
path = "../provide-foundation"
repo = "https://github.com/provide-io/provide-foundation.git"
layer = "foundation"

[[siblings]]
name = "provide-testkit"
path = "../provide-testkit"
repo = "https://github.com/provide-io/provide-testkit.git"
layer = "foundation"

[[siblings]]
name = "pyvider-cty"
path = "../pyvider-cty"
repo = "https://github.com/provide-io/pyvider-cty.git"
layer = "framework"

[[siblings]]
name = "pyvider"
path = "../pyvider"
repo = "https://github.com/provide-io/pyvider.git"
layer = "framework"
depends_on = ["provide-foundation", "pyvider-cty"]

[[siblings]]
name = "flavorpack"
path = "../flavorpack"
repo = "https://github.com/provide-io/flavorpack.git"
layer = "tools"
depends_on = ["provide-foundation"]

# ... more siblings

Configuration Sections¶

[workspace]: Basic workspace metadata - name: Workspace identifier - description: Human-readable description - version: Workspace configuration version

[workspace.python]: Python environment settings - version: Required Python version - venv_path: Where to create virtual environment

[workspace.tools]: Development tool requirements - List of tools with minimum versions

[[siblings]]: Repository definitions (array of tables) - name: Package name - path: Relative path from workspace - repo: Git repository URL - layer: Architecture layer (foundation/framework/tools) - depends_on: Other siblings this depends on

Using wrknv Commands¶

While provide-workenv provides bash scripts, wrknv offers additional capabilities:

List Siblings¶

wrknv siblings list
# Shows all configured sibling repositories

Check Status¶

wrknv status
# Shows git status of all siblings

Update All¶

wrknv update
# Pulls latest changes in all siblings

Run Command Across Siblings¶

wrknv exec --all "git status"
# Runs command in each sibling repository

Why Not Use wrknv Commands Directly?¶

provide-workenv provides bash scripts instead of using wrknv commands directly because:

Simplicity: Bash scripts are more transparent and easier to debug
Portability: Works without wrknv installed (can bootstrap it)
Customization: Easy to modify behavior for provide.io specifics
Learning Curve: Standard bash is familiar to all developers
Bootstrap Problem: Need to clone repositories before wrknv can manage them

However, wrknv is still valuable for: - Configuration format (wrknv.toml) - Sibling detection and management - Advanced workspace automation - Integration with other tools

Creating Your Own wrknv Workspace¶

You can use provide-workenv as a template for your own multi-repo workspace:

1. Create Workspace Repository¶

mkdir my-workspace
cd my-workspace
git init

2. Create wrknv.toml¶

[workspace]
name = "my-workspace"
description = "My multi-repository workspace"

[[siblings]]
name = "package-one"
path = "../package-one"
repo = "https://github.com/me/package-one.git"

[[siblings]]
name = "package-two"
path = "../package-two"
repo = "https://github.com/me/package-two.git"

3. Create Bootstrap Script¶

#!/usr/bin/env bash
# bootstrap.sh

# Parse wrknv.toml and clone repositories
# (See provide-workenv/scripts/bootstrap.sh for full example)

echo "Cloning repositories from wrknv.toml..."
# ... clone logic ...

4. Create Setup Script¶

#!/usr/bin/env bash
# setup.sh

# Create venv and install packages
python3 -m venv .venv
source .venv/bin/activate

# Install packages in order
pip install -e ../package-one
pip install -e ../package-two

wrknv vs provide-workenv¶

Aspect	wrknv	provide-workenv
Type	General tool	Specific workspace
Purpose	Work environment management	provide.io ecosystem coordination
Configuration	Creates wrknv.toml	Provides wrknv.toml
Commands	General workspace commands	Ecosystem-specific scripts
Users	Any multi-repo project	provide.io developers

Analogy: - wrknv : Make :: provide-workenv : Makefile - wrknv : Task :: provide-workenv : Taskfile - wrknv : Docker :: provide-workenv : docker-compose.yml

Advanced wrknv Features¶

wrknv provides features that provide-workenv doesn't currently use:

Task Automation¶

[workspace.tasks]
test = "pytest tests/"
lint = "ruff check ."
format = "ruff format ."

Run with: wrknv run test

Environment Variables¶

[workspace.env]
LOG_LEVEL = "DEBUG"
PYTHONPATH = "src:."

Pre/Post Hooks¶

[workspace.hooks]
pre_install = "scripts/pre_install.sh"
post_install = "scripts/post_install.sh"

Next Steps¶

Development Workflow - Working with the workspace
Configuration Reference - wrknv.toml details
wrknv Documentation - Full wrknv capabilities