chore: upgrade tooling

Author: shortcuts

DOCKER_README.md

@@ -1,41 +1,7 @@
-In this page you will find our recommended way of installing Docker on your machine. 
-This guide is made for OSX users.
-
-## Install Docker
-
-First install Docker using [Homebrew](https://brew.sh/)
-```
-$ brew install docker
-```
-
-You can then install [Docker Desktop](https://docs.docker.com/get-docker/) if you wish, or use `docker-machine`. As we prefer the second option, we will only document this one.
-
-## Setup your Docker
-
-Install `docker-machine`
-```
-$ brew install docker-machine
-```
-
-Then install [VirtualBox](https://www.virtualbox.org/) with [Homebrew Cask](https://github.com/Homebrew/homebrew-cask) to get a driver for your Docker machine
-```
-$ brew cask install virtualbox
-```
-
-You may need to enter your password and authorize the application in your `System Settings` > `Security & Privacy`.
-
-Create now a new machine, set it up as default and connect your shell to it (here we use zsh. The commands should anyway be displayed in each steps' output)
-
-```
-$ docker-machine create --driver virtualbox default
-$ docker-machine env default
-$ eval "$(docker-machine env default)"
-```
-
-Now you're all setup to use our provided Docker image!
-
 ## Build the image
 
+> Make sure to have [Docker installed](https://docs.docker.com/engine/install/)
+
 ```bash
 docker build -t algoliasearch-django .
 ```
@@ -53,8 +19,8 @@ docker run -it --rm --env ALGOLIA_APPLICATION_ID=XXXXXX \
 However, we advise you to export them. That way, you can use [Docker's shorten syntax](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) to set your variables.
 
 ```bash
-export ALGOLIA_APPLICATION_ID=XXXXXX 
-export ALGOLIA_API_KEY=XXX 
+export ALGOLIA_APPLICATION_ID=XXXXXX
+export ALGOLIA_API_KEY=XXX
 
 docker run -it --rm --env ALGOLIA_APPLICATION_ID --env ALGOLIA_API_KEY -v $PWD:/code -w /code algoliasearch-django bash
 ```
@@ -64,8 +30,8 @@ Once your container is running, any changes you make in your IDE are directly re
 To launch the tests, you can use this command
 
 ```bash
-tox -e py36-django31
+tox -e py313-django51
 ```
 
-If you'd like to sue an env other that `py36-django31`, run `tox --listenvs` to see the list of available envs.
+If you'd like to sue an env other that `py313-django51`, run `tox --listenvs` to see the list of available envs.
 Feel free to contact us if you have any questions.

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.8-slim
+FROM python:3.13-slim
 
 # Force the stdout and stderr streams to be unbuffered.
 # Ensure python output goes to your terminal
@@ -7,6 +7,6 @@ ENV PYTHONUNBUFFERED=1
 WORKDIR /code
 COPY requirements.txt /code/
 
-RUN pip install -r requirements.txt
+RUN pip3 install --upgrade pip && pip3 install -r requirements.txt
 
 COPY . /code/

MAINTAINERS.md

@@ -2,4 +2,4 @@
 
 | Name            | Email               |
 |-----------------|---------------------|
-| Paul-Louis Nech | [email protected] |
+| Algolia         | [email protected] |

README.md

@@ -12,7 +12,6 @@
   </p>
 </p>
 
-
 <p align="center">
   <a href="https://www.algolia.com/doc/framework-integration/django/options/?language=python" target="_blank">Documentation</a>  •
   <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
@@ -26,55 +25,56 @@
 
 You can find the full reference on [Algolia's website](https://www.algolia.com/doc/framework-integration/django/).
 
-
-
 1. **[Setup](#setup)**
-    * [Introduction](#introduction)
-    * [Install](#install)
-    * [Setup](#setup)
-    * [Quick Start](#quick-start)
+
+   - [Introduction](#introduction)
+   - [Install](#install)
+   - [Setup](#setup)
+   - [Quick Start](#quick-start)
 
 1. **[Commands](#commands)**
-    * [Commands](#commands)
+
+   - [Commands](#commands)
 
 1. **[Search](#search)**
-    * [Search](#search)
+
+   - [Search](#search)
 
 1. **[Geo-Search](#geo-search)**
-    * [Geo-Search](#geo-search)
+
+   - [Geo-Search](#geo-search)
 
 1. **[Tags](#tags)**
-    * [Tags](#tags)
+
+   - [Tags](#tags)
 
 1. **[Options](#options)**
-    * [Custom <code>objectID</code>](#custom-codeobjectidcode)
-    * [Custom index name](#custom-index-name)
-    * [Field Preprocessing and Related objects](#field-preprocessing-and-related-objects)
-    * [Index settings](#index-settings)
-    * [Restrict indexing to a subset of your data](#restrict-indexing-to-a-subset-of-your-data)
-    * [Multiple indices per model](#multiple-indices-per-model)
-    * [Temporarily disable the auto-indexing](#temporarily-disable-the-auto-indexing)
 
-1. **[Tests](#tests)**
-    * [Run Tests](#run-tests)
+   - [Custom <code>objectID</code>](#custom-codeobjectidcode)
+   - [Custom index name](#custom-index-name)
+   - [Field Preprocessing and Related objects](#field-preprocessing-and-related-objects)
+   - [Index settings](#index-settings)
+   - [Restrict indexing to a subset of your data](#restrict-indexing-to-a-subset-of-your-data)
+   - [Multiple indices per model](#multiple-indices-per-model)
+   - [Temporarily disable the auto-indexing](#temporarily-disable-the-auto-indexing)
 
-1. **[Troubleshooting](#troubleshooting)**
-    * [Frequently asked questions](#frequently-asked-questions)
+1. **[Tests](#tests)**
 
+   - [Run Tests](#run-tests)
 
+1. **[Troubleshooting](#troubleshooting)**
+   - [Frequently asked questions](#frequently-asked-questions)
 
 # Setup
 
-
-
 ## Introduction
 
 This package lets you easily integrate the Algolia Search API to your [Django](https://www.djangoproject.com/) project. It's based on the [algoliasearch-client-python](https://github.com/algolia/algoliasearch-client-python) package.
 
 You might be interested in this sample Django application providing a typeahead.js based auto-completion and Google-like instant search: [algoliasearch-django-example](https://github.com/algolia/algoliasearch-django-example).
 
-- Compatible with **Python 2.7** and **Python 3.4+**.
-- Supports **Django 1.7+**, **2.x** and **3.x**.
+- Compatible with **Python 3.8+**.
+- Supports **Django 4.x** and **5.x**.
 
 ## Install
 
@@ -95,10 +95,10 @@ ALGOLIA = {
 
 There are several optional settings:
 
-* `INDEX_PREFIX`: prefix all indices. Use it to separate different applications, like `site1_Products` and `site2_Products`.
-* `INDEX_SUFFIX`: suffix all indices. Use it to differentiate development and production environments, like `Location_dev` and `Location_prod`.
-* `AUTO_INDEXING`: automatically synchronize the models with Algolia (default to **True**).
-* `RAISE_EXCEPTIONS`: raise exceptions on network errors instead of logging them (default to **settings.DEBUG**).
+- `INDEX_PREFIX`: prefix all indices. Use it to separate different applications, like `site1_Products` and `site2_Products`.
+- `INDEX_SUFFIX`: suffix all indices. Use it to differentiate development and production environments, like `Location_dev` and `Location_prod`.
+- `AUTO_INDEXING`: automatically synchronize the models with Algolia (default to **True**).
+- `RAISE_EXCEPTIONS`: raise exceptions on network errors instead of logging them (default to **settings.DEBUG**).
 
 ## Quick Start
 
@@ -134,25 +134,17 @@ class YourModelIndex(AlgoliaIndex):
 
 ```
 
-
-
 # Commands
 
-
-
 ## Commands
 
-* `python manage.py algolia_reindex`: reindex all the registered models. This command will first send all the record to a temporary index and then moves it.
-    * you can pass ``--model`` parameter to reindex a given model
-* `python manage.py algolia_applysettings`: (re)apply the index settings.
-* `python manage.py algolia_clearindex`: clear the index
-
-
+- `python manage.py algolia_reindex`: reindex all the registered models. This command will first send all the record to a temporary index and then moves it.
+  - you can pass `--model` parameter to reindex a given model
+- `python manage.py algolia_applysettings`: (re)apply the index settings.
+- `python manage.py algolia_clearindex`: clear the index
 
 # Search
 
-
-
 ## Search
 
 We recommend using our [InstantSearch.js library](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/) to build your search
@@ -169,12 +161,8 @@ params = { "hitsPerPage": 5 }
 response = raw_search(Contact, "jim", params)
 ```
 
-
-
 # Geo-Search
 
-
-
 ## Geo-Search
 
 Use the `geo_field` attribute to localize your record. `geo_field` should be a callable that returns a tuple (latitude, longitude).
@@ -195,12 +183,8 @@ class ContactIndex(AlgoliaIndex):
 algoliasearch.register(Contact, ContactIndex)
 ```
 
-
-
 # Tags
 
-
-
 ## Tags
 
 Use the `tags` attributes to add tags to your record. It can be a field or a callable.
@@ -212,16 +196,12 @@ class ArticleIndex(AlgoliaIndex):
 
 At query time, specify `{ tagFilters: 'tagvalue' }` or `{ tagFilters: ['tagvalue1', 'tagvalue2'] }` as search parameters to restrict the result set to specific tags.
 
-
-
 # Options
 
-
-
 ## Custom `objectID`
 
 You can choose which field will be used as the `objectID `. The field should be unique and can
-    be a string or integer. By default, we use the `pk` field of the model.
+be a string or integer. By default, we use the `pk` field of the model.
 
 ```python
 class ArticleIndex(AlgoliaIndex):
@@ -279,8 +259,8 @@ class ContactIndex(AlgoliaIndex):
 
 - With this configuration, you can search for a `Contact` using its `Account` names
 - You can use the associated `account_ids` at search-time to fetch more data from your
-model (you should **only proxy the fields relevant for search** to keep your records' size
-as small as possible)
+  model (you should **only proxy the fields relevant for search** to keep your records' size
+  as small as possible)
 
 ## Index settings
 
@@ -400,12 +380,8 @@ with disable_auto_indexing(MyModel):
 
 ```
 
-
-
 # Tests
 
-
-
 ## Run Tests
 
 To run the tests, first find your Algolia application id and Admin API key (found on the Credentials page).
@@ -414,8 +390,8 @@ To run the tests, first find your Algolia application id and Admin API key (foun
 ALGOLIA_APPLICATION_ID={APPLICATION_ID} ALGOLIA_API_KEY={ADMIN_API_KEY} tox
 ```
 
-
 To override settings for some tests, use the [settings method](https://docs.djangoproject.com/en/1.11/topics/testing/tools/#django.test.SimpleTestCase.settings):
+
 ```python
 class OverrideSettingsTestCase(TestCase):
     def setUp(self):
@@ -433,15 +409,12 @@ class OverrideSettingsTestCase(TestCase):
         # ...
 ```
 
-
-
 # Troubleshooting
 
 # Use the Dockerfile
+
 If you want to contribute to this project without installing all its dependencies, you can use our Docker image. Please check our [dedicated guide](DOCKER_README.md) to learn more.
 
 ## Frequently asked questions
 
 Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/framework-integration/django/faq/) where you will find answers for the most common issues and gotchas with the package.
-
-

requirements.txt

@@ -1,5 +1,5 @@
-django>=1.7
-algoliasearch>=3.0,<4.0
+django>=4.0
+algoliasearch>=4.0,<5.0
 # dev dependencies
 pypandoc
 wheel

setup.py

@@ -20,18 +20,18 @@
 
 path_version = os.path.join(os.path.dirname(__file__),
                             'algoliasearch_django/version.py')
-if sys.version_info[0] == 3:
-    exec(open(path_version).read())
+if sys.version_info < (3, 8):
+    raise RuntimeError("algoliasearch_django 4.x requires Python 3.8+")
 else:
-    execfile(path_version)
+    exec(open(path_version).read())
 
 
 setup(
     name='algoliasearch-django',
     version=VERSION,
     license='MIT License',
     packages=find_packages(exclude=['tests']),
-    install_requires=['django>=1.7', 'algoliasearch>=3.0,<4.0'],
+    install_requires=['django>=4.0', 'algoliasearch>=4.0,<5.0'],
     description='Algolia Search integration for Django',
     long_description=README,
     long_description_content_type='text/markdown',
@@ -47,8 +47,12 @@
         'License :: OSI Approved :: MIT License',
         'Operating System :: OS Independent',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
         'Topic :: Internet :: WWW/HTTP',
     ]
 )