Skip to content

Installation

Requirements

  • Python 3.8+ - Required
  • pip - Package manager
  • Git - For version control (optional)

Quick Install

pip install projex

Verify Installation

projex --version
# Output: projex, version 4.0.0

projex --help
# Shows all available commands

Install from Source

For development or latest features:

# Clone repository
git clone https://github.com/ChAbdulWahhab/projex.git
cd projex

# Install in editable mode
pip install -e .

Upgrade Projex

pip install --upgrade projex

Uninstall

pip uninstall projex

Platform-Specific Notes

Windows

# Install
pip install projex

# Add to PATH if needed
# Python Scripts folder should be in PATH

Linux/Mac

# Install
pip3 install projex

# If permission error
pip3 install --user projex

# Create virtual environment
python -m venv venv

# Activate
source venv/bin/activate  # Linux/Mac
venv\Scripts\activate     # Windows

# Install
pip install projex

Dependencies

Projex automatically installs:

  • click - CLI framework
  • rich - Beautiful terminal output
  • jinja2 - Template engine
  • requests - HTTP library

Troubleshooting

Command not found

# Add Python Scripts to PATH
# Windows: Add C:\Python3X\Scripts to PATH
# Linux/Mac: Add ~/.local/bin to PATH

Permission Denied

# Use --user flag
pip install --user projex

SSL Certificate Error

# Use trusted host
pip install --trusted-host pypi.org --trusted-host files.pythonhosted.org projex

Next Steps