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.28.tar.gz (9.4 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.28-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mulch-0.1.28.tar.gz
  • Upload date:
  • Size: 9.4 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.28.tar.gz
Algorithm Hash digest
SHA256 06566973f67a60a37615151e26561a63e9cabd3509a9827856e7981d2ac3e118
MD5 803f5d29877b5e3ad1b46c118b955d77
BLAKE2b-256 60d20fc606a1d9dd9262b1631eef00e66c3fe6300867e440f7968f8c7e48cf35

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mulch-0.1.28-py3-none-any.whl
  • Upload date:
  • Size: 14.1 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.28-py3-none-any.whl
Algorithm Hash digest
SHA256 26134b703fe0a9e979b62ebd07a1ac453709b5fe3c49535b7d741bf3fe47ab1a
MD5 4721bad0b361f74d2009d5936fdba652
BLAKE2b-256 31d37f81cd048650b7ba1cc6aaab57ddbf3df4d9e30316fa8f53fe7b5d5372b9

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