django-meilisearch

Name	django-meilisearch JSON
Version	0.1.0 JSON
	download
home_page	None
Summary	None
upload_time	2025-02-11 03:03:34
maintainer	None
docs_url	None
author	Lucas Rocha
requires_python	<4.0,>=3.9
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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) ???

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "django-meilisearch",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Lucas Rocha",
    "author_email": "lucash.rocha@hotmail.com",
    "download_url": "https://files.pythonhosted.org/packages/83/7c/75c4db57f3087d59d6317b4c57e9b0e3b29d4db0af46157130522e29d9fc/django_meilisearch-0.1.0.tar.gz",
    "platform": null,
    "description": "# Django Meilisearch\n\nA Meilisearch integration for Django project\n\n## How to run\n\nStart a Docker container with Meilisearch:\n\n> docker run --rm -p 7700:7700 getmeili/meilisearch:latest\n\nInit a python virtual environment:\n\n> poetry install\n\nou\n\n> python3 -m venv venv\n\nRun the Django development server\n\n> task serve\n\n## Initial tasks\n\n- [x] Implements documents class\n- [x] Implements search method\n- [x] Implements commands (create_index, delete_index, populate, rebuild, ...)\n- [x] Refactor DocType and Document classes to separated files\n- [x] Create django signals to add, update or remove data from index\n- [x] Create search method that returns queryset\n- [x] Create a progress viewer while indexing data\n- [x] Config Mypy type checking and solve errors\n- [x] Config Black code format and apply it\n- [x] Solve Pylint advices\n- [ ] Implements results iterator using serializers\n- [x] Review tests coverage\n- [x] Implements GitHub Actions workflow\n- [ ] Implements views (explore indexed data) ???\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e05054c52df573c04c7571569a271fc2cc4465fa3aa30dc40025ea4d2d27759d",
                "md5": "4f36738cdcbb7be6b28004a2238ea51d",
                "sha256": "55da2f58b7ade19ed1bb4f0f9ef9c801b77078286578a63519ea702187d7a5d3"
            },
            "downloads": -1,
            "filename": "django_meilisearch-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4f36738cdcbb7be6b28004a2238ea51d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 17637,
            "upload_time": "2025-02-11T03:03:32",
            "upload_time_iso_8601": "2025-02-11T03:03:32.925509Z",
            "url": "https://files.pythonhosted.org/packages/e0/50/54c52df573c04c7571569a271fc2cc4465fa3aa30dc40025ea4d2d27759d/django_meilisearch-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "837c75c4db57f3087d59d6317b4c57e9b0e3b29d4db0af46157130522e29d9fc",
                "md5": "c3f51c1325006ef96c0b248abfaba999",
                "sha256": "cdcd4f64b6118bdb339c1863dc3c73eeca812f3518b8662dca366d301a6c1be7"
            },
            "downloads": -1,
            "filename": "django_meilisearch-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c3f51c1325006ef96c0b248abfaba999",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 11601,
            "upload_time": "2025-02-11T03:03:34",
            "upload_time_iso_8601": "2025-02-11T03:03:34.255556Z",
            "url": "https://files.pythonhosted.org/packages/83/7c/75c4db57f3087d59d6317b4c57e9b0e3b29d4db0af46157130522e29d9fc/django_meilisearch-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-11 03:03:34",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "django-meilisearch"
}