Skip to content

suggested use of venv in the README? #5

@T-NhanNguyen

Description

@T-NhanNguyen

Having ran through the installation on my new macbook, I've realized that this should probably suggest the user to create a venv in their project directory before installing the package, not only because it's beta, but it seems there are problems with the mac installation process.

Specifically, modern macOS versions (standard since Python 3.11/3.12) implement PEP 668, which marks the environment as externally managed. This prevents global pip installs to protect the system Python integrity. If a user tries to install the package directly, they will likely encounter an error or a version mismatch if their system defaults to Python 3.9, which does not meet the requirement of Python >= 3.10.

To ensure a smooth setup, the documentation should recommend the following workflow:

# Create a virtual environment in the current directory
python3 -m venv .venv

# Activate the environment
source .venv/bin/activate

# Install the package within the isolated environment
pip install plumb-dev

Using this method bypasses the externally-managed-environment error and ensures that plumb-dev has the specific dependencies it needs without conflicting with other system-level tools.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions