Skip to content

setup-guide.md

Latest commit

 

History

History
60 lines (46 loc) · 1.46 KB

setup-guide.md

File metadata and controls

60 lines (46 loc) · 1.46 KB

Setup Guide

Prerequisites

  • OS: Linux (Debian/Ubuntu, RHEL/Fedora, Arch), macOS, or Windows (WSL2).
  • Dependencies:
    • git
    • python3 (3.10+)
    • curl
    • jq
    • make

Installation

  1. Clone the Repository:

    git clone https://github.com/freddiedfre/python-env-manager.git
cd python-env-manager

  2. Run Installer:

    make install

    This script will:

    • Check for required dependencies.
    • Install pem executable to ~/.local/bin.
    • Create configuration directory at ~/.config/python-env-manager.
    • Create data directory at ~/.local/share/python-env-manager.

  3. Update PATH: Ensure ~/.local/bin is in your PATH. Add this to your shell config (.bashrc, .zshrc):

    export PATH="$HOME/.local/bin:$PATH"

  4. Enable Shell Completion: Source the completion script in your shell config:

    source ~/.local/share/python-env-manager/scripts/utils/completion.sh

Configuration

The configuration file is located at ~/.config/python-env-manager/config.env.

Key Options

  • PROJECTS_ROOT: Directory where new projects are created.
  • DEFAULT_PYTHON_VERSION: Default Python version (e.g., "3.12").
  • IDE_COMMON_PACKAGES: List of packages installed in IDE environments.
  • ENABLE_ANALYTICS: Toggle local usage tracking.

Uninstallation

To remove PEM from your system:

make uninstall