Contributing

# Fork the repository on GitHub, then clone your fork
git clone https://github.com/YOUR_USERNAME/fkapi.git
cd fkapi

# Add upstream remote
git remote add upstream https://github.com/sunr4y/fkapi.git

python -m venv venv

# On Windows
venv\Scripts\activate

# On Linux/Mac
source venv/bin/activate

# Install production dependencies
pip install -r fkapi/requirements.txt

# Install development dependencies (includes testing and linting tools)
pip install -r fkapi/requirements-dev.txt

# Django Settings
DJANGO_SECRET_KEY=your-secret-key-here-for-development
DJANGO_DEBUG=True
DJANGO_ALLOWED_HOSTS=localhost,127.0.0.1

# Database
DATABASE_URL=postgresql://user:password@localhost:5432/fkapi
# Or use SQLite for development:
# DATABASE_URL=sqlite:///db.sqlite3

# Redis (optional for development)
REDIS_URL=redis://localhost:6379/1

# API Settings
DJANGO_API_ENABLE_AUTH=False
API_RATE_LIMIT_RATE=100/hour

# Create database (PostgreSQL)
createdb fkapi

# Run migrations
cd fkapi
python manage.py migrate

# Create superuser (optional)
python manage.py createsuperuser

# Install pre-commit
pip install pre-commit

# Install git hooks
pre-commit install

# Start development server
python manage.py runserver

# In another terminal, test API
curl http://localhost:8000/api/health

# Access admin interface at http://localhost:8000/admin
# API documentation at http://localhost:8000/api/docs

fkapi/
├── core/                    # Main application code
│   ├── models.py           # Database models (Kit, Club, Season, etc.)
│   ├── views.py            # Django views
│   ├── api.py              # API endpoints (Django Ninja)
│   ├── scrapers.py         # Web scraping logic
│   ├── parsers.py          # HTML parsing
│   ├── services/           # Business logic layer
│   │   ├── kits_service.py
│   │   ├── clubs_service.py
│   │   └── scraping_service.py
│   ├── middleware.py       # Custom middleware (rate limiting, monitoring)
│   ├── cache_utils.py      # Cache utilities and invalidation
│   ├── management/         # Django management commands
│   └── tests/              # Test files
├── fkapi/                  # Django project settings
│   ├── settings.py         # Main settings
│   ├── urls.py             # URL routing
│   └── api.py              # API configuration
├── docs/                   # Documentation
├── requirements.txt        # Production dependencies
└── requirements-dev.txt   # Development dependencies

# Update your main branch
git checkout main
git pull upstream main

# Create a feature branch
git checkout -b feature/your-feature-name
# or for bug fixes:
git checkout -b fix/bug-description

# Run all tests
pytest

# Run specific test file
pytest fkapi/core/tests/test_api.py

# Run with coverage report
pytest --cov=fkapi/core --cov-report=html

# Run specific test markers
pytest -m unit  # Run only unit tests
pytest -m "not slow"  # Skip slow tests

# Run Ruff linter
ruff check .

# Auto-fix issues
ruff check --fix .

# Format code
ruff format .

# Type checking (optional)
mypy fkapi/core

# Stage your changes
git add .

# Commit with a descriptive message
git commit -m "Add feature: description of your changes"

# Pre-commit hooks will run automatically
# If they fail, fix the issues and commit again

# Push to your fork
git push origin feature/your-feature-name

## Description
Brief description of changes

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Testing
How has this been tested?

## Checklist
- [ ] Code follows style guidelines
- [ ] Tests added/updated
- [ ] Documentation updated
- [ ] All tests pass locally

@api.get("/my-endpoint", response=MySchema)
def my_endpoint(request: HttpRequest):
    """Endpoint description."""
    return MyModel.objects.all()