Installation¶

Requirements¶

Python 3.11+
Django 4.2+
Django REST Framework 3.12+

Install¶

pip install fc-selector

Or with uv:

uv add fc-selector

Configuration¶

Add fc_selector to your INSTALLED_APPS:

# settings.py
INSTALLED_APPS = [
    # ...
    'rest_framework',
    'fc_selector',
]

That's it! No additional configuration required.

Optional: DRF Spectacular¶

For automatic OpenAPI/Swagger documentation of OData parameters, install drf-spectacular:

pip install drf-spectacular

# settings.py
INSTALLED_APPS = [
    # ...
    'drf_spectacular',
]

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
}

Development Installation¶

For contributing or development:

git clone https://github.com/alexandre-fundcraft/fc-selector.git
cd fc-selector

# Using uv (recommended)
uv sync --group dev

# Using pip
pip install -e ".[dev]"

Verify Installation¶

from fc_selector.django.selector import ODataSelector, QueryBuilder

print("FC Selector installed successfully!")