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.26.tar.gz (9.2 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.26-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mulch-0.1.26.tar.gz
  • Upload date:
  • Size: 9.2 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.26.tar.gz
Algorithm Hash digest
SHA256 880301d043115fa7ffacf9b96a8cab6bd813c52a5d04e3ae70f3c6cd089179c6
MD5 611c8e932aeef1cc5036e6e2506793d6
BLAKE2b-256 4c835db027ba699f3d7036464a7c04f8051a3e38a90a4816f0e5cda4626536b5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mulch-0.1.26-py3-none-any.whl
  • Upload date:
  • Size: 13.6 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.26-py3-none-any.whl
Algorithm Hash digest
SHA256 69403ebbe473d2890999f0faf7fc9b05f81b87f6b4ae43367f76379558e15cc7
MD5 379ed95aa6d72682596b84fde479cb80
BLAKE2b-256 8692851d76a344966d52ba8543ae4ed7c1f84b5d8a5b1c092f21b630c1f3e64d

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