Documentation: Missing proper setup instructions

[josephmcasey]

This project has many interesting approaches to its development environment. Perhaps one of particular interest is the use of mise, which I have enjoyed using. Upon first installation of mise, it appears some additional documentation is required beyond mise install. At least during my experiment attempting to resolve #40 , I found myself needing to run the following commands first to successfully setup the repository

mise settings experimental=true
mise use -g python
pip install --user pipx
mise install

Issue 1 - Go requires experimental settings

(base) josephcasey@Josephs-MacBook-Pro prefect-operator % mise install --verbose 
DEBUG ARGS: /Users/josephcasey/.local/bin/mise install --verbose
DEBUG config: ~/github.com/PrefectHQ/prefect-operator/.mise.toml
DEBUG install_some_versions: [email protected] go:golang.org/x/tools/cmd/[email protected] [email protected]
INFO  [email protected]                       install
INFO  go:golang.org/x/tools/cmd/[email protected] install
INFO  [email protected]                     install
INFO  [email protected]                     pipx install yamllint==1.35.1
DEBUG $ pipx install yamllint==1.35.1
Error: 
   0: failed to install go:github.com/onsi/ginkgo/v2/[email protected]
   1: go backend is experimental. Enable it with `mise settings experimental=true`

Location:
   src/config/settings.rs:323

Version:
   2025.3.2 macos-arm64 (2025-03-07)

Backtrace omitted. Run with RUST_BACKTRACE=1 environment variable to display it.
Run with RUST_BACKTRACE=full to include source snippets.
(base) josephcasey@Josephs-MacBook-Pro prefect-operator % mise settings experimental=true
(base) josephcasey@Josephs-MacBook-Pro prefect-operator % mise install --verbose         
DEBUG ARGS: /Users/josephcasey/.local/bin/mise install --verbose
DEBUG config: ~/github.com/PrefectHQ/prefect-operator/.mise.toml
DEBUG config: ~/.config/mise/config.toml
DEBUG install_some_versions: [email protected] go:golang.org/x/tools/cmd/[email protected] [email protected]
INFO  [email protected]                       install
INFO  [email protected]                     install
INFO  go:golang.org/x/tools/cmd/[email protected] install
DEBUG $ go install github.com/onsi/ginkgo/v2/[email protected]
INFO  [email protected]                     pipx install yamllint==1.35.1
DEBUG $ go install golang.org/x/tools/cmd/[email protected]
DEBUG $ pipx install yamllint==1.35.1
go: downloading golang.org/x/tools v0.25.0
go: downloading golang.org/x/mod v0.21.0
go: downloading golang.org/x/sync v0.8.0
INFO  go:golang.org/x/tools/cmd/[email protected] ✓ installed
INFO  [email protected]                     ✓ installed
Error: 
   0: failed to install pipx:[email protected]
   1: failed to execute command: pipx install yamllint==1.35.1
   2: No such file or directory (os error 2)

Location:
   src/cmd.rs:313

Version:
   2025.3.2 macos-arm64 (2025-03-07)

Backtrace omitted. Run with RUST_BACKTRACE=1 environment variable to display it.
Run with RUST_BACKTRACE=full to include source snippets.

Issue 2 - YamlLint requires pipx

(base) josephcasey@Josephs-MacBook-Pro prefect-operator %
mise use -g python
pip install --user pipx

mise hint use multiple versions simultaneously with mise use [email protected] [email protected]
mise hint installing precompiled python from astral-sh/python-build-standalone
if you experience issues with this python (e.g.: running poetry), switch to python-build by running mise settings python.compile=1
mise [email protected]                ✓ installed                                                                                                                                                                         mise ~/.config/mise/config.toml tools: [email protected]
Requirement already satisfied: pipx in /Users/josephcasey/.local/lib/python3.12/site-packages (1.7.1)
Requirement already satisfied: argcomplete>=1.9.4 in /Users/josephcasey/.local/lib/python3.12/site-packages (from pipx) (3.6.0)
Requirement already satisfied: packaging>=20 in /opt/anaconda3/lib/python3.12/site-packages (from pipx) (24.1)
Requirement already satisfied: platformdirs>=2.1 in /opt/anaconda3/lib/python3.12/site-packages (from pipx) (3.10.0)
Requirement already satisfied: userpath!=1.9,>=1.6 in /Users/josephcasey/.local/lib/python3.12/site-packages (from pipx) (1.9.2)
Requirement already satisfied: click in /opt/anaconda3/lib/python3.12/site-packages (from userpath!=1.9,>=1.6->pipx) (8.1.7)
(base) josephcasey@Josephs-MacBook-Pro prefect-operator % mise install
creating virtual environment...
creating shared libraries...
upgrading shared libraries...
installing yamllint from spec 'yamllint==1.35.1'...
done! ✨ 🌟 ✨
mise [email protected]              ✓ installed          

Related Documentation

• https://mise.jdx.dev/dev-tools/backends/pipx.html#dependencies
• Tool dependencies jdx/mise#2536

OS Specifications

• macOS: 14.7.4 (23H420)
• Chipset: Apple M3 Max

[josephmcasey]

Resolved by #149