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

pipx install mulch

git clone

git clone https://github.com/yourusername/mulch.git
cd mulch
poetry install
poetry build
pipx install dist/mulch-0.1.0-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

Setup

From the root of your mulch repo

poetry build

Install it with pipx

pipx install dist/mulch-0.1.0-py3-none-any.whl

Now you can run:

mulch --help mulch init ./target-software

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mulch-0.1.9.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.9.tar.gz
Algorithm Hash digest
SHA256 6436b80a4b29e5ec636c6c2f774dcc48d6c8b3cf8bd91a7ec721f2392d11119c
MD5 f02b9fe772a484520564139addfb23f2
BLAKE2b-256 3961c28fffa5ba870ce5a6e0aba284e1c59fdb1dfaffa5e6dc2c32ab1a35f16d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mulch-0.1.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 31e383ac2f70a02f2f15262af51efd52f8dd96666108413030ecd32aadf461fe
MD5 289727aea77bb14967b4a0d1d4aef30c
BLAKE2b-256 e611cecdcc9f168a745f58da77d8a2058735ba45dc0a580a6e3d340a1f3feaf8

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