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.
Set up new projects easily with workspace scaffolding and source-code templating. Key feature: Benefit from introspective directory geters and file getters in the workspace_manager.py file in src, dictated by mulch-scaffold.json and protected by mulch.lock.
Features
- Initialize workspaces with a consistent scaffold defined by
mulch-scaffold.json - Create a
default-workspace.tomlto 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
# Generated a fresh mulch-scaffold.json file, to edit before running 'mulch init'.
mulch file
# 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.30.tar.gz
(11.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
mulch-0.1.30-py3-none-any.whl
(16.9 kB
view details)
File details
Details for the file mulch-0.1.30.tar.gz.
File metadata
- Download URL: mulch-0.1.30.tar.gz
- Upload date:
- Size: 11.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fce49a398d5b0f7daf706202ff95eb7c13aa4301cb603b87dc1b1b826ed76881
|
|
| MD5 |
5a82c319d7fe2eab60a7b470488d60b5
|
|
| BLAKE2b-256 |
60131c06ba3076649191d42f28738cfb494dd0b45ae0f698ad6d69345920155a
|
File details
Details for the file mulch-0.1.30-py3-none-any.whl.
File metadata
- Download URL: mulch-0.1.30-py3-none-any.whl
- Upload date:
- Size: 16.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9fb91029c68ad1e38e988b061ad995a96592cf8015c4dac888bb4745013899bb
|
|
| MD5 |
14e2484955404b390a1b569cf3ba51b6
|
|
| BLAKE2b-256 |
315b74a19dfcab3da88b6e2311acfe8b6085b2314cb2d460c7dbd98a72c9e780
|