Installation

Requirements

Django Flexi Tag has the following requirements:

Python: 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12
Django: 1.11, 2.0, 2.1, 2.2, 3.0, 3.1, 3.2, 4.0, 4.1, 4.2, 5.0
Django REST Framework (for API endpoints)
PostgreSQL database (required for JSONField and efficient tag queries)

Installation Steps

Install the package using pip:
```
pip install dj-flexi-tag
```

Add ‘flexi_tag’ to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    # ...
    'flexi_tag',
    # ...
]

Run migrations to create necessary database tables:
```
python manage.py migrate
```

Database Configuration

Django Flexi Tag uses PostgreSQL’s JSONField and GIN indexes for efficient tag storage and querying. Make sure your database settings in settings.py are configured for PostgreSQL:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'your_db_name',
        'USER': 'your_db_user',
        'PASSWORD': 'your_db_password',
        'HOST': 'localhost',
        'PORT': '5432',
    }
}

Optional Configuration

Custom Exception Integration

If your project has a custom base exception class, you can configure Flexi Tag to use it:

# settings.py
FLEXI_TAG_BASE_EXCEPTION_CLASS = 'myproject.exceptions.MyBaseException'

This ensures all Flexi Tag exceptions inherit from your project’s base exception for consistent error handling.

Next Steps

After installation, you’ll need to:

Make your models “taggable” by inheriting from FlexiTagMixin
Generate tag models using the management command (which will also automatically create migrations)
Apply migrations to create the new tag model tables
Add the TaggableViewSetMixin to your ViewSets for API support
Use TaggableService instance methods for programmatic tag management

See the Quick Start guide for detailed instructions on these steps.