Skip to main content

Workspace Factory CLI for initializing standard workspace folders

Project description

mulch — Workspace Factory CLI

mulch is a lightweight, project-agnostic CLI tool to scaffold and generate workspace directories for any Python project. It bootstraps a standardized workspace folder structure and configuration files inside your project directory.


Features

  • Initialize workspaces with a consistent scaffold defined by scaffold.json
  • Create a default-workspace.toml to track the active workspace
  • Works standalone and project-agnostic; no assumptions about your repo layout
  • Easily installable and runnable via pipx

Installation

pipx

pipx install mulch

git clone

git clone https://github.com/yourusername/mulch.git
cd mulch
poetry install
poetry build
pipx install dist/mulch-*-py3-none-any.whl

Usage

# Initialize workspace named 'default' in the current directory
mulch init

# Initialize workspace named 'workspace1' in ./myproject
mulch init ./myproject --name workspace1

# Initialize workspace named 'workspace1' in the current directory
mulch init --name workspace1

# Skip creating default-workspace.toml
mulch init ./myproject --name workspace1 --no-set-default

Setup

From the root of your mulch repo

poetry build

Install it with pipx

pipx install dist/mulch-*-py3-none-any.whl

Now you can run:

mulch --help mulch init ./target-software

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mulch-0.1.10.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mulch-0.1.10-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file mulch-0.1.10.tar.gz.

File metadata

  • Download URL: mulch-0.1.10.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for mulch-0.1.10.tar.gz
Algorithm Hash digest
SHA256 2fc420239a29b282c78b577e784f3d7e5689943e159f0807abdfe5016452c62f
MD5 9c219cc6db94266397ceb990a370fdd5
BLAKE2b-256 cd92cba971683a46d10bb4dc69acf4fe369573b09f45ab8f2094031c66007a14

See more details on using hashes here.

File details

Details for the file mulch-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: mulch-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for mulch-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 94294af35f3bdab39e83362b34bbb44eeb3c9f73311ebd35e98be415a4ac1274
MD5 b837e9eaa36ad7412c4985338ac5c13f
BLAKE2b-256 230d3c1e014ddd70ffacfc949ea55478b3c65f86033e7bbd048e765d7334a7b1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page