Metadata-Version: 2.4
Name: collaborativenotes-utils
Version: 0.1.3
Summary: Scoring, ranking and search utilities for CollaborativeNotes
Author: Ayush Singh
Project-URL: Homepage, https://github.com/yourusername/collaborativenotes-utils
Keywords: notes,scoring,ranking,search,education
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# collaborativenotes-utils

Scoring, ranking and search utilities for the CollaborativeNotes Django app.

## Install

```bash
pip install collaborativenotes-utils
```

## Usage

```python
from collaborativenotes_utils import rank_notes, group_by_collection, search_score

# Rank notes by relevance to a search query + rating + downloads
ranked = rank_notes(notes, query="databases")

# Get a single note's relevance score
score = search_score(note, query="normalisation")

# group uploaded notes by collection name 
grouped = group_by_collection(notes)
```
