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 (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.11.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.11-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mulch-0.1.11.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.11.tar.gz
Algorithm Hash digest
SHA256 034cc9338eb871eb63f3c8074f9bdd365cf82248ac144fdca6b72ac75fb7fd3a
MD5 4c5564b85104d9e6b37ebf2df4727822
BLAKE2b-256 eb13bd7d32d60e9d404131a6dbb9eab2b77aa83450e00e10afd655b746dda6cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mulch-0.1.11-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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 5bbf932b5c0b3008460cecbb8a1c272c29fada285f6eee78b714cfb7d5b67af8
MD5 f6d4c4e85e59080404627d35107a50d4
BLAKE2b-256 b810e8d2bbafcd0ac5f0bd3e70a30ac14b37fae139457d2abd42c02772b165c3

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