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.21.tar.gz (5.0 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.21-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mulch-0.1.21.tar.gz
  • Upload date:
  • Size: 5.0 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.21.tar.gz
Algorithm Hash digest
SHA256 b589c1abc05655942e6b8b0e86d11271c9ada30f347c32dd9e7dd80b8b19848f
MD5 a46c8159eedd39ac927160a5c704bd96
BLAKE2b-256 e45aed4083e25c56a382debfa400f711213a58579c2b2bb59da6a4971fbb18c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mulch-0.1.21-py3-none-any.whl
  • Upload date:
  • Size: 7.7 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.21-py3-none-any.whl
Algorithm Hash digest
SHA256 bcffda257aa0a610006f77bf3acd47c4ae96a01b4411988334761bde0ad5a740
MD5 918aa965bcac5b45294049d96414aa52
BLAKE2b-256 7cacdba2dbef7be39077af774e274e21a99ac7e8d3bc9f107bfa479f5c18485d

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