From de66379967cb1f61dbd53f08fcaa5431f8d7184f Mon Sep 17 00:00:00 2001 From: aitbc1 Date: Thu, 26 Mar 2026 18:18:40 +0100 Subject: [PATCH] ENHANCE: Add virtual environment setup and convenient alias to installation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ✅ INSTALLATION IMPROVEMENTS: - Added virtual environment setup (required for Python 3.13.5+) - Added convenient alias setup for easy CLI access - Updated both quick installation and development setup - Fixed externally-managed-environment issue 🔧 TECHNICAL FIXES: ✅ Virtual environment: python3 -m venv venv (required) ✅ Activation: source venv/bin/activate ✅ Alias setup: echo 'alias aitbc="source /opt/aitbc/cli/venv/bin/activate && aitbc"' >> ~/.bashrc ✅ Development setup: Complete virtual environment workflow 📋 INSTALLATION STEPS UPDATED: ✅ Quick Installation: Full venv + alias setup ✅ Development Setup: Complete dev environment with alias ✅ User Experience: Can now use 'aitbc' from anywhere ✅ Error Prevention: Avoids externally-managed-environment error 🎯 USER BENEFITS: ✅ Easy CLI access from any directory ✅ Proper Python environment isolation ✅ No installation errors on modern systems ✅ Professional development workflow ✅ Consistent with existing setup (matches user's alias) STATUS: Installation instructions now complete and user-friendly --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a68f05f4..b5dfeb05 100644 --- a/README.md +++ b/README.md @@ -166,18 +166,32 @@ The system requirements are based on actual project configuration: git clone https://github.com/oib/AITBC.git cd AITBC -# Install CLI tool +# Install CLI tool (requires virtual environment) cd cli +python3 -m venv venv +source venv/bin/activate pip install -e . # Verify installation aitbc version aitbc --help + +# OPTIONAL: Add convenient alias for easy access +echo 'alias aitbc="source /opt/aitbc/cli/venv/bin/activate && aitbc"' >> ~/.bashrc +source ~/.bashrc +# Now you can use 'aitbc' from anywhere! ``` ### **🔧 Development Setup:** ```bash -# Install development dependencies +# Clone the repository +git clone https://github.com/oib/AITBC.git +cd AITBC + +# Install CLI tool (requires virtual environment) +cd cli +python3 -m venv venv +source venv/bin/activate pip install -e ".[dev]" # Verify correct Python version @@ -191,6 +205,10 @@ pytest # Install pre-commit hooks pre-commit install + +# OPTIONAL: Add convenient alias for easy access +echo 'alias aitbc="source /opt/aitbc/cli/venv/bin/activate && aitbc"' >> ~/.bashrc +source ~/.bashrc ``` ### **⚠️ Version Compliance:**