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.24.tar.gz (9.1 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.24-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mulch-0.1.24.tar.gz
  • Upload date:
  • Size: 9.1 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.24.tar.gz
Algorithm Hash digest
SHA256 8b1b4438189b642f40ea888c1d9822bc711f63655bf0d7235f82e493c04fa34a
MD5 6b8ed9cb2051ca78f9b964dbaa002ec3
BLAKE2b-256 0f0d1f439355f3113d56fe561080ec51eabe8aaec5c389890043e93e8cf8ce84

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mulch-0.1.24-py3-none-any.whl
  • Upload date:
  • Size: 13.5 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.24-py3-none-any.whl
Algorithm Hash digest
SHA256 ec75d89e3aa0b01b45b7dfc6fd1b75aa03d4d684a84101fe46cbe4c0a8851668
MD5 bfd9ac487a5e7ee3df65553a78896122
BLAKE2b-256 38461651443db34cc27a7df78da88804bc375283c286dc915ded0f896b88afde

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