django-recompi 2.1.5

Integration of RecomPI with Django models for recommendation and tracking functionalities.

Django RecomPI

Django RecomPI is a Django model mixin that integrates functionalities of RecomPI (Recommender System API) with Django models, enabling easy recommendation and tracking capabilities within Django applications.

Installation

You can install Django RecomPI via pip. Here's how:

pip install django-recompi

Quick Start

Setting up a Django model with RecomPI integration

1. Define your Django model (e.g., Product) and use RecomPIModelMixin as a mixin.

from django.db import models
from django_recompi.models import RecomPIModelMixin

class Product(models.Model, RecomPIModelMixin):
    RECOMPI_DATA_FIELDS = [
        "name",
        "reviews__comment",
        "reviews__rating",
        "reviews__counter.count",
    ]
    name = models.CharField(max_length=100, db_index=True)
    description = models.TextField()

    def __str__(self):
        return self.name

2. Define related models such as Review and ReviewCounter with appropriate fields.

from django.db import models

class Review(models.Model):
    product = models.ForeignKey(Product, related_name="reviews", on_delete=models.CASCADE)
    comment = models.CharField(max_length=200, db_index=True)
    rating = models.CharField(choices=RatingChoices.choices, max_length=1, db_index=True)
    counter = models.ForeignKey("ReviewCounter", related_name="reviews", on_delete=models.CASCADE, default=None, null=True, blank=True)

    def __str__(self):
        return f"Review of {self.product.name} - {self.rating}"

class ReviewCounter(models.Model):
    count = models.IntegerField(default=0)

Tracking interactions

# Track user interaction with a product
product = Product.objects.first()

# Using SecureProfile to hash profile identifiers before sending to RecomPI
profile = SecureProfile("profile_id", "user_profile_id")

# Providing location information including optional data
location = Location(
    ip="1.1.1.1",          # Optional: IP address of the user
    url="https://www.example.com/products/1",
    referer="REFERER_URL", # Optional: Referring URL
    useragent="USERAGENT"  # Optional: User agent of the client
)

# Tracking the interaction using RecomPI integration
product.recompi_track(
    "product-view",  # Interaction label
    profile,         # SecureProfile instance
    location         # Location instance
)

This revised version clarifies the usage of SecureProfile and Location classes while also providing a clear example of how to track user interactions with a product using the recompi_track method. We encourage you to refer to the original RecomPI package documentation for detailed information on these classes and other useful utilities like Profile.

Getting recommendations

# Get product recommendations for a user
recommendations = Product.recompi_recommend(
    "product-view",
    SecureProfile("profile_id", "user_profile_id"),
)

# Example of printing recommendations
print(
    {
        k: {"name": p.name, "recommedation-rank": p.recompi_rank}
        for k, pp in recommendations.items()
        for p in pp
    }
)

Settings Configuration

Django RecomPI can be customized through the following settings in your settings.py file, you can read the full documentation here; but the most important settings you much set in your settings.py is RECOMPI_API_KEY:

RECOMPI_API_KEY

• Type: str
• Description: API key for accessing the RecomPI service. Required for integration.
• Note: To obtain RECOMPI_API_KEY, register on the RecomPI panel. After registration, add a campaign in the panel, and a campaign token will be generated instantly. Use this token as your API key in the code.

Security Considerations

Ensure the following security best practices when using Django RecomPI:

• Secure API Key Handling: Keep RECOMPI_API_KEY secure and avoid exposing it in version control or public repositories.
• Data Encryption: Use HTTPS (RECOMPI_SECURE_API) to encrypt data transmitted between your Django application and the RecomPI service.
• Secure Profile Hashing: Utilize RECOMPI_SECURE_HASH_SALT to hash profile IDs and other data obscuring before sending them to RecomPI servers. This helps protect user data by obscuring identifiable information during transmission and afterward.

Examples and Use Cases

Explore these examples to understand how Django RecomPI can be applied:

• E-commerce Recommendation: Track user interactions on product pages and recommend related products based on their behavior.
• Content Personalization: Customize content recommendations based on user preferences and historical interactions.

In-Depth Guide

Explore our in-depth guide to uncover advanced topics and features of the django-recompi package. This section provides essential insights for developing sophisticated recommendation systems using RecomPI. For detailed information, visit the Advanced Documentation.

Basic Usage

The django-recompi package is built on top of the core recompi package. Therefore, understanding the foundational concepts and functionalities in the recompi package is essential. For an introduction to the basic usage of django-recompi, including how to work with essential classes like SecureProfile and Profile, please refer to our PyPI page. This resource offers comprehensive examples and instructions to help you get started with implementing fundamental features of the RecomPI recommendation system.

---

Contributing and Development

We welcome contributions to Django RecomPI! If you'd like to contribute, please follow these steps:

• Fork the repository and clone it to your local environment.
• Install dependencies and set up a development environment.

python3 -m venv venv
source venv/bin/activate
pip install -r requirements-dev.txt
pre-commit install --hook-type pre-commit --hook-type pre-push

• Make changes, write tests, and ensure all tests pass.
• Submit a pull request with a detailed description of your changes.

Support

For support or questions, please submit a ticket or open an issue on GitHub.