Skip to content

SETUP_VERIFICATION.md

Latest commit

 

History

History
273 lines (216 loc) · 5.57 KB

SETUP_VERIFICATION.md

File metadata and controls

273 lines (216 loc) · 5.57 KB
Raw

Setup Verification Checklist

Local Setup Verification

1. Python Environment

# Check Python version
python --version
# Expected: Python 3.12.x

# Check virtual environment
which python
# Expected: /path/to/venv/bin/python

2. Dependencies

# Check package installed
python -c "import ai_project; print(ai_project.__version__)"
# Expected: 0.1.0

# Check key dependencies
python -c "import pandas; import pydantic; import pytest; print('All dependencies OK')"
# Expected: All dependencies OK

3. Tests

# Run all tests
pytest

# Expected output:
# ===== test session starts =====
# collected 48+ items
# tests/unit/processors/test_loader.py ....
# tests/unit/processors/test_validator.py ....
# tests/unit/processors/test_cleaner.py ....
# tests/unit/processors/test_feature_eng.py ....
# tests/unit/core/test_pipeline.py ....
# tests/integration/test_pipeline_flow.py ....
# ===== 48+ passed in X.XXs =====

4. Code Quality

# Format check
black --check src tests
# Expected: All done! ✨

# Lint check
ruff check src tests
# Expected: No errors

# Type check
pyright src
# Expected: 0 errors, 0 warnings

# Coverage
pytest --cov=src/ai_project --cov-fail-under=80
# Expected: coverage >= 80%

5. CLI

# Test CLI
ai-project info
# Expected: Shows app info

ai-project validate tests/fixtures/test_data/sample.csv
# Expected: Validation output

Git Setup Verification

1. Git Repository

# Check git status
git status
# Expected: On branch main, nothing to commit

# Check remote
git remote -v
# Expected: origin https://github.com/YOUR_USERNAME/ai-project.git (fetch)
#           origin https://github.com/YOUR_USERNAME/ai-project.git (push)

2. Git History

# Check commits
git log --oneline | head -5
# Expected: Recent commits visible

# Check branches
git branch -a
# Expected: * main (current branch)

GitHub Verification

1. Repository

# Check if repository exists
curl -s https://api.github.com/repos/YOUR_USERNAME/ai-project | grep '"name"'
# Expected: "name": "ai-project"

2. GitHub Pages

# Check if GitHub Pages is enabled
curl -s https://api.github.com/repos/YOUR_USERNAME/ai-project/pages | grep '"status"'
# Expected: "status": "built"

# Visit GitHub Pages site
# Expected: https://YOUR_USERNAME.github.io/ai-project/

3. CI/CD Workflows

# Check if workflows are running
# Go to: https://github.com/YOUR_USERNAME/ai-project/actions
# Expected: Green checkmarks on recent commits

Complete Verification Script

Save as verify_setup.sh:

#!/bin/bash

echo "🔍 AI Data Pipeline Setup Verification"
echo "======================================"
echo ""

# Python
echo "✓ Checking Python..."
python --version || exit 1

# Dependencies
echo "✓ Checking dependencies..."
python -c "import ai_project; import pandas; import pytest" || exit 1

# Tests
echo "✓ Running tests..."
pytest -q || exit 1

# Code quality
echo "✓ Checking code quality..."
black --check src tests > /dev/null 2>&1 || exit 1
ruff check src tests > /dev/null 2>&1 || exit 1
pyright src > /dev/null 2>&1 || exit 1

# Git
echo "✓ Checking git..."
git status > /dev/null 2>&1 || exit 1
git remote -v | grep origin > /dev/null 2>&1 || exit 1

# CLI
echo "✓ Checking CLI..."
ai-project info > /dev/null 2>&1 || exit 1

echo ""
echo "✅ All checks passed!"
echo ""
echo "Next steps:"
echo "1. Push to GitHub: git push origin main"
echo "2. Create release: git tag v0.1.0 && git push origin v0.1.0"
echo "3. Check GitHub Pages: https://YOUR_USERNAME.github.io/ai-project/"

Run verification:

chmod +x verify_setup.sh
./verify_setup.sh

Troubleshooting

Tests Failing

# Run with verbose output
pytest -vv

# Run specific test
pytest tests/unit/processors/test_loader.py -v

# Check coverage
pytest --cov=src/ai_project --cov-report=html
open htmlcov/index.html

Code Quality Issues

# Auto-fix formatting
black src tests

# Auto-fix linting
ruff check --fix src tests

# Check type errors
pyright src --outputjson

Git Issues

# Check git config
git config --list

# Check remote
git remote -v

# Verify SSH key
ssh -T git@github.com

GitHub Pages Not Working

  1. Check Settings → Pages
  2. Verify source is main branch, /docs folder
  3. Check Actions tab for deployment errors
  4. Wait 1-2 minutes for deployment
  5. Clear browser cache

Final Checklist

  • Python 3.12+ installed
  • Virtual environment activated
  • Dependencies installed
  • All tests passing (48+)
  • Code quality checks passing
  • CLI working
  • Git repository initialized
  • Remote configured
  • Code pushed to GitHub
  • GitHub Pages enabled
  • GitHub Pages site accessible
  • CI/CD workflows running
  • First release tagged

Success Indicators

✅ Local Development

  • All tests pass
  • Code quality checks pass
  • CLI works
  • Can run make quality without errors

✅ GitHub Repository

  • Repository visible at github.com/YOUR_USERNAME/ai-project
  • Code pushed to main branch
  • All files present

✅ GitHub Pages

  • Site accessible at YOUR_USERNAME.github.io/ai-project
  • Documentation links work
  • GitHub link points to repository

✅ CI/CD

  • Workflows show green checkmarks
  • Tests run automatically on push
  • Coverage reports generated

Support

If verification fails:

  1. Check error messages carefully
  2. Review TROUBLESHOOTING.md
  3. Check DEVELOPMENT.md
  4. Review GITHUB_SETUP.md
  5. Open GitHub issue with error details

Last Updated: January 16, 2026