oib/aitbc
1
0
Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity

ENHANCE: Add virtual environment setup and convenient alias to installation
Some checks failed
AITBC CI/CD Pipeline / lint-and-test (3.13.5) (push) Has been cancelled
Details
AITBC CI/CD Pipeline / test-cli (push) Has been cancelled
Details
AITBC CI/CD Pipeline / test-services (push) Has been cancelled
Details
AITBC CI/CD Pipeline / test-production-services (push) Has been cancelled
Details
AITBC CI/CD Pipeline / security-scan (push) Has been cancelled
Details
AITBC CI/CD Pipeline / build (push) Has been cancelled
Details
AITBC CI/CD Pipeline / deploy-staging (push) Has been cancelled
Details
AITBC CI/CD Pipeline / deploy-production (push) Has been cancelled
Details
AITBC CI/CD Pipeline / performance-test (push) Has been cancelled
Details
AITBC CI/CD Pipeline / docs (push) Has been cancelled
Details
AITBC CI/CD Pipeline / release (push) Has been cancelled
Details
AITBC CI/CD Pipeline / notify (push) Has been cancelled
Details
GPU Benchmark CI / gpu-benchmark (3.13.5) (push) Has been cancelled
Details
Security Scanning / Bandit Security Scan (apps/coordinator-api/src) (push) Has been cancelled
Details
Security Scanning / Bandit Security Scan (cli/aitbc_cli) (push) Has been cancelled
Details
Security Scanning / Bandit Security Scan (packages/py/aitbc-core/src) (push) Has been cancelled
Details
Security Scanning / Bandit Security Scan (packages/py/aitbc-crypto/src) (push) Has been cancelled
Details
Security Scanning / Bandit Security Scan (packages/py/aitbc-sdk/src) (push) Has been cancelled
Details
Security Scanning / Bandit Security Scan (tests) (push) Has been cancelled
Details
Security Scanning / CodeQL Security Analysis (javascript) (push) Has been cancelled
Details
Security Scanning / CodeQL Security Analysis (python) (push) Has been cancelled
Details
Security Scanning / Dependency Security Scan (push) Has been cancelled
Details
Security Scanning / Container Security Scan (push) Has been cancelled
Details
Security Scanning / OSSF Scorecard (push) Has been cancelled
Details
Security Scanning / Security Summary Report (push) Has been cancelled
Details

Browse Source 
✅ 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
This commit is contained in:
aitbc1
2026-03-26 18:18:40 +01:00
parent a373d85d47
commit de66379967
1 changed files with 20 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -166,18 +166,32 @@ The system requirements are based on actual project configuration:
git clone https://github.com/oib/AITBC.git git clone https://github.com/oib/AITBC.git
cd AITBC cd AITBC
# Install CLI tool # Install CLI tool (requires virtual environment)
cd cli cd cli
python3 -m venv venv
source venv/bin/activate
pip install -e . pip install -e .
# Verify installation # Verify installation
aitbc version aitbc version
aitbc --help 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:** ### **🔧 Development Setup:**
```bash ```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]" pip install -e ".[dev]"
# Verify correct Python version # Verify correct Python version
@@ -191,6 +205,10 @@ pytest
# Install pre-commit hooks # Install pre-commit hooks
pre-commit install 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:** ### **⚠️ Version Compliance:**