postgres-fts-backend 0.0.1__tar.gz

postgres_fts_backend-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Forest Gregg, 2024 Datamade
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

postgres_fts_backend-0.0.1/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: postgres-fts-backend
+Version: 0.0.1
+Summary: A PostgreSQL Full Text Seach Backend for Haystack
+Author-email: Forest Gregg <fgregg@datamade.us>
+Project-URL: Repository, https://github.com/fgregg/postgres-fts-backend
+Project-URL: Issues, https://github.com/fgregg/postgres-fts-backend/issues
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django>=5.0
+Requires-Dist: django-haystack>=2.8.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-django; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: django-stubs; extra == "dev"
+Dynamic: license-file
+
+# postgres-fts-backend
+
+A [Django Haystack](https://django-haystack.readthedocs.io/) backend that uses
+PostgreSQL's built-in full-text search. No external search service required.
+
+## Requirements
+
+- Python >= 3.12
+- Django >= 5.0
+- django-haystack >= 2.8.0
+- PostgreSQL
+
+## Installation
+
+```bash
+pip install postgres-fts-backend
+```
+
+Add to `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    "django.contrib.postgres",
+    "haystack",
+    "postgres_fts_backend",
+    # ...
+]
+```
+
+Set a migration module so the generated search index migrations live in
+your project rather than inside the installed package:
+
+```python
+MIGRATION_MODULES = {
+    "postgres_fts_backend": "myapp.search_migrations",
+}
+```
+
+Configure Haystack:
+
+```python
+HAYSTACK_CONNECTIONS = {
+    "default": {
+        "ENGINE": "postgres_fts_backend.PostgresFTSEngine",
+    },
+}
+```
+
+To use a search configuration other than `"english"`:
+
+```python
+HAYSTACK_CONNECTIONS = {
+    "default": {
+        "ENGINE": "postgres_fts_backend.PostgresFTSEngine",
+        "SEARCH_CONFIG": "spanish",
+    },
+}
+```
+
+## Other Peculiarities of this backend
+
+### Build indexes through models and migrations
+
+```bash
+python manage.py build_postgres_schema
+python manage.py migrate postgres_fts_backend
+```
+
+Run these two commands again whenever you change a `SearchIndex` definition.
+
+### Fuzzy search
+
+Fuzzy queries use PostgreSQL's trigram similarity matching (`pg_trgm`):
+
+```python
+results = SearchQuerySet().filter(author__fuzzy="Janee")
+```
+
+The similarity threshold is controlled by PostgreSQL's
+`pg_trgm.similarity_threshold` setting (default 0.3). To adjust it:
+
+```sql
+ALTER DATABASE mydb SET pg_trgm.similarity_threshold = 0.5;
+```
+
+### `more_like_this` not implemented
+PostgreSQL FTS doesn't provide any facilities for this. It could be done, but I just need to think more about it.
+
+### `spelling_suggestions` are not supported

postgres_fts_backend-0.0.1/README.md

@@ -0,0 +1,89 @@
+# postgres-fts-backend
+
+A [Django Haystack](https://django-haystack.readthedocs.io/) backend that uses
+PostgreSQL's built-in full-text search. No external search service required.
+
+## Requirements
+
+- Python >= 3.12
+- Django >= 5.0
+- django-haystack >= 2.8.0
+- PostgreSQL
+
+## Installation
+
+```bash
+pip install postgres-fts-backend
+```
+
+Add to `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    "django.contrib.postgres",
+    "haystack",
+    "postgres_fts_backend",
+    # ...
+]
+```
+
+Set a migration module so the generated search index migrations live in
+your project rather than inside the installed package:
+
+```python
+MIGRATION_MODULES = {
+    "postgres_fts_backend": "myapp.search_migrations",
+}
+```
+
+Configure Haystack:
+
+```python
+HAYSTACK_CONNECTIONS = {
+    "default": {
+        "ENGINE": "postgres_fts_backend.PostgresFTSEngine",
+    },
+}
+```
+
+To use a search configuration other than `"english"`:
+
+```python
+HAYSTACK_CONNECTIONS = {
+    "default": {
+        "ENGINE": "postgres_fts_backend.PostgresFTSEngine",
+        "SEARCH_CONFIG": "spanish",
+    },
+}
+```
+
+## Other Peculiarities of this backend
+
+### Build indexes through models and migrations
+
+```bash
+python manage.py build_postgres_schema
+python manage.py migrate postgres_fts_backend
+```
+
+Run these two commands again whenever you change a `SearchIndex` definition.
+
+### Fuzzy search
+
+Fuzzy queries use PostgreSQL's trigram similarity matching (`pg_trgm`):
+
+```python
+results = SearchQuerySet().filter(author__fuzzy="Janee")
+```
+
+The similarity threshold is controlled by PostgreSQL's
+`pg_trgm.similarity_threshold` setting (default 0.3). To adjust it:
+
+```sql
+ALTER DATABASE mydb SET pg_trgm.similarity_threshold = 0.5;
+```
+
+### `more_like_this` not implemented
+PostgreSQL FTS doesn't provide any facilities for this. It could be done, but I just need to think more about it.
+
+### `spelling_suggestions` are not supported