Installation Guide¶

# Check Python version
python --version
# or
python3 --version

# Check pip version
pip --version

# Create virtual environment
python -m venv flort-env

# Activate (Linux/macOS)
source flort-env/bin/activate

# Activate (Windows)
flort-env\Scripts\activate

# Install Flort
pip install flort

# Deactivate when done
deactivate

# Create conda environment
conda create -n flort python=3.9

# Activate environment
conda activate flort

# Install Flort
pip install flort

# Deactivate
conda deactivate

# Install pipenv (if needed)
pip install pipenv

# Create environment and install
pipenv install flort

# Activate shell
pipenv shell

# Run Flort
flort --help

# Clone repository
git clone https://github.com/watkinslabs/flort.git
cd flort

# Create virtual environment
python -m venv venv
source venv/bin/activate  # Linux/macOS
# or venv\Scripts\activate  # Windows

# Install in development mode
pip install -e .

# Install development dependencies
pip install -e .[dev]

# Testing tools
pip install pytest pytest-cov

# Code quality
pip install black flake8 isort mypy

# Documentation
pip install -r docs/requirements.txt

# All development tools
pip install -e .[dev,docs]

# Test curses availability
python -c "import curses; print('✅ Curses available')"

# If missing, install development packages
# Ubuntu/Debian
sudo apt install python3-dev libncurses5-dev

# Fedora
sudo dnf install python3-devel ncurses-devel

# Install curses support for Windows
pip install windows-curses

# Test installation
python -c "import curses; print('✅ Curses available')"

# Or install Flort with UI support
pip install flort[ui]

# Check version
flort --version

# Display help
flort --help

# Test basic functionality
flort . --extensions txt --manifest --max-depth 1

# Test curses support
python -c "
try:
    import curses
    print('✅ Interactive UI supported')
except ImportError:
    print('❌ Interactive UI not available')
"

# Test Flort UI (exit with 'q')
flort --ui

# Create test directory
mkdir flort-test
cd flort-test

# Create test files
echo "print('hello')" > test.py
echo "# Test Project" > README.md

# Test all major features
flort . --extensions py,md --outline --output test.txt

# Check output
cat test.txt

# Cleanup
cd ..
rm -rf flort-test

# Use --user flag
pip install --user flort

# Or create virtual environment
python -m venv venv
source venv/bin/activate
pip install flort

# Check if pip installed to user directory
python -m pip show flort

# Add to PATH (Linux/macOS)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# Windows: Add Python Scripts folder to PATH

# Reinstall in clean environment
pip uninstall flort
pip install flort

# Check Python path
python -c "import sys; print(sys.path)"

# Windows: Install curses support
pip install windows-curses

# Linux: Install development packages
sudo apt install python3-dev libncurses5-dev

# Test fallback mode
flort . --extensions py  # Skip --ui flag

# If using system Python and getting SSL errors
/Applications/Python\ 3.x/Install\ Certificates.command

# If pip is outdated
python -m pip install --upgrade pip

# If getting "Microsoft Visual C++ required" error
# Download and install Microsoft C++ Build Tools

# If Python is not in PATH
py -m pip install flort

# If getting "No module named _curses"
sudo apt install python3-dev libncurses5-dev

# If pip install fails with permissions
pip install --user flort

# Update from PyPI
pip install --upgrade flort

# Update development installation
cd flort
git pull
pip install -e .

# Check current version
flort --version

# Check available versions
pip index versions flort

# Uninstall Flort
pip uninstall flort

# Remove configuration (if any)
rm -rf ~/.flort

# Remove virtual environment
rm -rf flort-env

# Completely clean install
pip uninstall flort
pip cache purge
pip install flort