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 mulch-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 (recommended)

pipx install mulch

git clone

git clone https://github.com/city-of-memphis/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

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.29.tar.gz (9.5 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.29-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mulch-0.1.29.tar.gz
  • Upload date:
  • Size: 9.5 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.29.tar.gz
Algorithm Hash digest
SHA256 da4398dd4b960ccb93d2897d963be543c139a6f478615288b5f05a5744c737d5
MD5 020846c7dc19e6c687ceb1b6dad9171f
BLAKE2b-256 da448b940212c101fb2f28d50c963bb8ca669521dba3939c1bbb458372726ede

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mulch-0.1.29-py3-none-any.whl
  • Upload date:
  • Size: 14.3 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.29-py3-none-any.whl
Algorithm Hash digest
SHA256 13b6144fc7b2aa8a576decb509992649af342e0cacc981d81b340aba87115324
MD5 6339474719c19c2e45e75ace02a880db
BLAKE2b-256 07aaa1c34f054fafe4a6f51b3451855fddf2cba1001f7893973def6c71dd632e

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