Metadata-Version: 2.3
Name: django-meilisearch
Version: 0.1.0
Summary: 
Author: Lucas Rocha
Author-email: lucash.rocha@hotmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: alive-progress (>=3.1.5,<4.0.0)
Requires-Dist: camel-converter (>=4.0.1,<5.0.0)
Requires-Dist: django (>=4,<5)
Requires-Dist: djangorestframework (>=3.15.2,<4.0.0)
Requires-Dist: meilisearch (>=0.31.4,<0.32.0)
Requires-Dist: poetry (>=2.0.0,<3.0.0)
Description-Content-Type: text/markdown

# Django Meilisearch

A Meilisearch integration for Django project

## How to run

Start a Docker container with Meilisearch:

> docker run --rm -p 7700:7700 getmeili/meilisearch:latest

Init a python virtual environment:

> poetry install

ou

> python3 -m venv venv

Run the Django development server

> task serve

## Initial tasks

- [x] Implements documents class
- [x] Implements search method
- [x] Implements commands (create_index, delete_index, populate, rebuild, ...)
- [x] Refactor DocType and Document classes to separated files
- [x] Create django signals to add, update or remove data from index
- [x] Create search method that returns queryset
- [x] Create a progress viewer while indexing data
- [x] Config Mypy type checking and solve errors
- [x] Config Black code format and apply it
- [x] Solve Pylint advices
- [ ] Implements results iterator using serializers
- [x] Review tests coverage
- [x] Implements GitHub Actions workflow
- [ ] Implements views (explore indexed data) ???

