✨ Let's start!

Author: archatas

.gitignore

@@ -0,0 +1,107 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+.static_storage/
+.media/
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Aidas Bendoraitis
+
+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.

README.md

@@ -0,0 +1,52 @@
+# Experiment with Django and Elasticsearch
+
+This Django project explores the possibilities of full-text search and filtering using Elasticsearch.
+
+## Dependencies
+
+The project depends on:
+
+- Django >=1.8
+- Elasticsearch 5.6 - Server
+- elasticsearch v5.5.1 - Python Elasticsearch Client
+- elasticsearch-dsl v5.4.0 - Higher level library for the search queries
+- django-elasticsearch-dsl v0.4.4 - Integration with Django package
+- several other modules listed in the requirements.txt
+
+## Quickstart
+
+1. Install and run Elasticsearch server. For example on macOS:
+
+    ```
+    $ brew install [email protected]
+    $ brew services start [email protected]
+    ```
+
+2. Create and activate a virtual environment:
+
+    ```
+    $ virtualenv venv
+    $ . venv/bin/activate
+    ```
+ 
+3. Clone this project
+
+4. Install pip requirements into the virtual environment:
+
+    ```
+    (venv)$ pip install -r requirements.txt
+    ```
+
+5. Build the search index for the database:
+
+    ```
+    (venv)$ python manage.py search_index --rebuild
+    ```
+
+6. Run local webserver:
+
+    ```
+    (venv)$ python manage.py runserver
+    ```
+
+7. Open http://127.0.0.1:8000 to play around with the search.

db.sqlite3

@@ -0,0 +1,4 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+default_app_config = 'library.libraryapp.apps.LibraryAppConfig'

library/__init__.py

@@ -0,0 +1,29 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+from django.contrib import admin
+from django.utils.translation import ugettext_lazy as _
+
+from .models import Author, Book
+
+
+@admin.register(Author)
+class AuthorAdmin(admin.ModelAdmin):
+    save_on_top = True
+    list_display = ["author_name"]
+    list_filter = ["book"]
+    search_fields = ["first_name", "last_name", "author_name"]
+    fieldsets = [
+        (_("Content"), {'fields': ["first_name", "last_name", "author_name"]}),
+    ]
+
+
+@admin.register(Book)
+class BookAdmin(admin.ModelAdmin):
+    save_on_top = True
+    list_display = ["title", "publishing_date"]
+    list_filter = ["authors"]
+    search_fields = ["title",]
+    fieldsets = [
+        (_("Content"), {'fields': ["title", "authors", "publishing_date"]}),
+    ]
+    filter_horizontal = ["authors"]

library/libraryapp/__init__.py

@@ -0,0 +1,12 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+from django.apps import AppConfig
+from django.utils.translation import ugettext_lazy as _
+
+
+class LibraryAppConfig(AppConfig):
+    name = 'library.libraryapp'
+    verbose_name = _("Library")
+
+    def ready(self):
+        pass

library/libraryapp/admin.py

@@ -0,0 +1,60 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+from django_elasticsearch_dsl import DocType, Index, fields
+from .models import Author, Book
+
+# Name of the Elasticsearch index
+search_index = Index('library')
+# See Elasticsearch Indices API reference for available settings
+search_index.settings(
+    number_of_shards=1,
+    number_of_replicas=0
+)
+
+
+@search_index.doc_type
+class AuthorDocument(DocType):
+    class Meta:
+        model = Author # The model associated with this DocType
+
+        # The fields of the model you want to be indexed in Elasticsearch
+        fields = [
+            'first_name',
+            'last_name',
+            'author_name',
+        ]
+
+        # Ignore auto updating of Elasticsearch when a model is saved
+        # or deleted:
+        # ignore_signals = True
+        # Don't perform an index refresh after every update (overrides global setting):
+        # auto_refresh = False
+        # Paginate the django queryset used to populate the index with the specified size
+        # (by default there is no pagination)
+        # queryset_pagination = 5000
+
+
+@search_index.doc_type
+class BookDocument(DocType):
+    authors = fields.NestedField(properties={
+        'first_name': fields.TextField(),
+        'last_name': fields.TextField(),
+        'author_name': fields.TextField(),
+        'pk': fields.IntegerField(),
+    }, include_in_root=True)
+
+    class Meta:
+        model = Book # The model associated with this DocType
+
+        # The fields of the model you want to be indexed in Elasticsearch
+        fields = [
+            'title',
+            'publishing_date',
+        ]
+        related_models = [Author]
+
+    def get_instances_from_related(self, related_instance):
+        """If related_models is set, define how to retrieve the Book instance(s) from the related model."""
+        if isinstance(related_instance, Author):
+            return related_instance.book_set.all()

library/libraryapp/apps.py

@@ -0,0 +1,22 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+from django import forms
+from django.utils.functional import LazyObject
+
+
+class SearchResults(LazyObject):
+    def __init__(self, search_object):
+        self._wrapped = search_object
+
+    def __len__(self):
+        return self._wrapped.count()
+
+    def __getitem__(self, index):
+        search_results = self._wrapped[index]
+        if isinstance(index, slice):
+            search_results = list(search_results)
+        return search_results
+
+
+class DateInput(forms.DateInput):
+    input_type = 'date'