simplesitesearch 0.0.1.dev1__py3-none-any.whl

simplesitesearch/__init__.py

@@ -0,0 +1,3 @@
+__version__ = '0.0.1.dev1'
+
+

simplesitesearch/cms_apps.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+from cms.app_base import CMSApp
+from cms.apphook_pool import apphook_pool
+from django.utils.translation import gettext_lazy as _
+
+
+@apphook_pool.register
+class SiteSearchApp(CMSApp):
+    app_name = "site_search"
+    name = _("Site Search")
+
+    def get_urls(self, page=None, language=None, **kwargs):
+        return ["simplesitesearch.urls"]

simplesitesearch/templates/simplesitesearch/pagination.html

@@ -0,0 +1,43 @@
+{% load i18n staticfiles cms_tags %}
+
+<div class="search__pagination d-flex justify-content-between justify-sm-content-center align-items-center">
+    <div class="search__pagination__nav search__pagination__nav--prev">
+    {% if prev_link %}
+        <a class="search__pagination__nav__item" href="{% url 'site_search:search' %}{{prev_link}}"><i class="fal fa-chevron-left"></i></a>
+    {% endif %}
+    </div>
+    <div class="d-flex search__pagination__links">
+    {% for page_link in page_links %}
+        <div class="search__pagination__link-container{% ifequal page_link.page current_page %} active{% endifequal %}">
+            <a class="search__pagination__link" href="{{ page_link.url }}">{{ page_link.page }}</a>
+        </div>
+    {% endfor %}
+    </div>
+    <div class="search__pagination__nav search__pagination__nav--next">
+    {% if next_link %}
+        <a class="search__pagination__nav__item" href="{% url 'site_search:search' %}{{next_link}}"><i class="fal fa-chevron-right"></i></a>
+    {% endif %}
+    </div>
+</div>
+
+{% comment %}
+<ul class="pagination">
+    {% if prev_link %}
+        <li>
+            <a href="{% url 'site_search:search' %}{{prev_link}}" class="term">«</a>
+        </li>
+    {% endif %}
+    
+    {% for page_link in page_links %}
+        <li{% ifequal page_link.page current_page %} class="active"{% endifequal %}>
+            <a href="{{ page_link.url }}" class="page">{{ page_link.page }}</a>
+        </li>
+    {% endfor %}
+       
+    {% if next_link %}
+        <li>
+            <a href="{% url 'site_search:search' %}{{next_link}}" class="term">»</a>
+        </li>
+    {% endif %}
+</ul>
+{% endcomment %}

simplesitesearch/templates/simplesitesearch/search_results.html

@@ -0,0 +1,55 @@
+{% extends "base.html" %}
+{% load i18n staticfiles cms_tags %}
+
+{% block template_class %}template_search{% endblock %}
+
+{% block content %}
+    <section id="search" class="section section--nopadding section--nomargin">
+        {% if results_count %}
+        <div class="search__about-container">
+            <div class="search__about d-sm-flex justify-content-between">
+                <div class="headings__third-container headings__third-container--noMargin">
+                    <div class="headings headings__third headings--white">
+                        <h3>{% trans "Search results for:" %} "{{ query }}"</h3>
+                    </div>
+                </div>
+                <div class="text-container">
+                    <div class="text text--white">
+                        <p>{{ results_count }} {% trans "result" %}{{ results_count|pluralize }}</p>
+                    </div>
+                </div>
+            </div>
+        </div>
+        {% endif %}
+    </section>
+    <section class="section">
+        <div class="search__content">
+            {% for result in results %}
+            <div class="search__content__result">
+                <div class="headings__third-container">
+                    <a class="headings headings__third headings--blue" href="{{result.url}}">{{ result.title|safe }}</a>
+                </div>
+                <div class="text-container">
+                    <div class="text text--graydark">
+                        <p>{{result.highlight|safe}}...</p>
+                    </div>
+                </div>
+            </div>
+            {% empty %}
+            <div class="search__content--empty">
+                <div class="headings__third-container">
+                    <div class="headings headings__third">
+                        <h3>{% trans "No results" %}</h3>
+                    </div>
+                </div>
+            </div>
+            {% endfor %}
+        </div>
+    </section>
+    {% if page_links|length > 1 %}
+    <section class="section section--nopadding section--nomargin">
+        {% include "pagination.html" %}
+    </section>
+    {% endif %}
+
+{% endblock %}

simplesitesearch/urls.py

@@ -0,0 +1,7 @@
+from django.urls import include, re_path
+
+from . import views
+
+urlpatterns = [
+    re_path(r'^$', views.SearchResult.as_view(), name='search'),
+]

simplesitesearch/views.py

@@ -0,0 +1,151 @@
+from math import floor
+
+import requests
+from django.conf import settings
+from django.utils.translation import get_language
+from django.views.generic import TemplateView
+
+
+def get_page_links(pages_count, current_page, term):
+
+    page_links = []
+
+    if pages_count > 1:
+
+        if current_page == 1:
+            from_page = 1
+            to_page = from_page + 7
+        if current_page == pages_count + 1:
+            pass
+        else:
+            from_page = current_page - 4
+            to_page = current_page + 5
+
+        if from_page < 1:
+            from_page = 1
+
+        if to_page > pages_count:
+            to_page = pages_count
+
+        for page in range(from_page, to_page + 1):
+            page_link = "?q=%s&page=%s" % (term, page)
+
+            page_links.append({
+                'page': page,
+                'url': page_link
+            })
+
+    return page_links
+
+
+def get_prev_next_links(next_page_number, prev_page_number, term):
+    next_link = None
+    if next_page_number:
+        next_link = "?q=%s&page=%s" % (term, next_page_number)
+
+    prev_link = None
+    if prev_page_number:
+        prev_link = "?q=%s&page=%s" % (term, prev_page_number)
+
+    return [prev_link, next_link]
+
+
+def get_prev_next_page_number(pages_count, current_page):
+
+    current_page = int(current_page)
+    pages_count - int(pages_count)
+
+    if current_page > 1:
+        prev_page_number = current_page - 1
+    else:
+        prev_page_number = None
+
+    if current_page < pages_count:
+        next_page_number = current_page + 1
+    else:
+        next_page_number = None
+
+    return [prev_page_number, next_page_number]
+
+
+def get_total_pages(total_hits):
+    pages_count = floor(total_hits / 10)
+
+    modulo = total_hits % 10
+    if modulo > 0:
+        pages_count = pages_count + 1
+
+    return pages_count
+
+
+def get_api_re_path(term, current_page):
+    base_url = settings.SITE_SEARCH_API_BASE_URL
+    site_key = settings.SITE_SEARCH_SITE_KEY
+    lang = get_language()
+
+    return "%s%s?term=%s&lang=%s&page=%s" % (base_url, site_key, term, lang, current_page)
+
+
+class SearchResult(TemplateView):
+
+    template_name = "simplesitesearch/search_results.html"
+
+    def get(self, request, *args, **kwargs):
+        context = self.get_context_data(**kwargs)
+
+        # get Term from url params
+        term = request.GET.get('q', None)
+        honeypot_message = request.GET.get('message', None)
+
+        # get current page from url params
+        current_page = int(request.GET.get('page', 1))
+
+        if term and not honeypot_message:
+
+            term = ' '.join(term.split()[:10])
+
+            # get api URl depending on current page
+            api_url = get_api_re_path(term, current_page)
+
+            # get results from api
+            response = requests.get(api_url, verify=False)
+            # convert results to usable json
+            try:
+                response_data = response.json()
+            except:
+                response_data = {
+                    'total_hits': 0,
+                    'hits': []
+                }
+
+            # get pages count
+            pages_count = get_total_pages(response_data['total_hits'])
+
+            # get prev and next page numbers
+            prev_page_number, next_page_number = get_prev_next_page_number(pages_count, current_page)
+
+            # get prev and next btn links
+            prev_link, next_link = get_prev_next_links(next_page_number, prev_page_number, term)
+
+            # get pages links
+            page_links = get_page_links(pages_count, current_page, term)
+
+            context.update({
+                'pages_count': pages_count,
+                'current_page': current_page,
+                'results_count': response_data['total_hits'],
+                'prev_link': prev_link,
+                'next_link': next_link,
+                'page_links': page_links,
+                'results': response_data['hits']
+            })
+        else:
+            context.update({
+                'results': None
+            })
+
+        context.update({
+            'query': term
+        })
+
+        return self.render_to_response(context)

simplesitesearch-0.0.1.dev1.dist-info/METADATA

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: simplesitesearch
+Version: 0.0.1.dev1
+Summary: Reptile Simple Site Search django app
+Home-page: https://github.com/reptiletech/simplesitesearch
+Author: Reptile Tech
+Author-email: Reptile Tech <flouis@reptile.tech>
+Maintainer-email: Reptile Tech <flouis@reptile.tech>
+License: MIT
+Project-URL: Homepage, https://github.com/reptiletech/simplesitesearch
+Project-URL: Documentation, https://github.com/reptiletech/simplesitesearch#readme
+Project-URL: Repository, https://github.com/reptiletech/simplesitesearch.git
+Project-URL: Bug Tracker, https://github.com/reptiletech/simplesitesearch/issues
+Keywords: django,search,cms,django-cms
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+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: Framework :: Django
+Classifier: Framework :: Django :: 2.2
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=2.2
+Requires-Dist: django-cms>=3.2
+Requires-Dist: requests>=2.22.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Simple Site Search
+
+A simple Django app for site search functionality with Django CMS integration. This package provides a clean, easy-to-use search interface that can be integrated into Django CMS projects.
+
+> **Note**: This is a development version (0.0.1.dev1). The package is still under active development and may have breaking changes in future releases.
+
+## Features
+
+- **Django CMS Integration**: Seamlessly integrates with Django CMS as an apphook
+- **Pagination Support**: Built-in pagination for search results
+- **Multi-language Support**: Supports internationalization with Django's i18n framework
+- **Customizable Templates**: Easy to customize search result templates
+- **API Integration**: Connects to external search APIs (like AddSearch)
+- **Responsive Design**: Bootstrap-compatible templates
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install simplesitesearch
+```
+
+## Configuration
+
+### 1. Add to INSTALLED_APPS
+
+Add `simplesitesearch` to your Django project's `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    # ... other apps
+    'simplesitesearch',
+    # ... other apps
+]
+```
+
+### 2. Required Settings
+
+Add the following settings to your Django settings file:
+
+```python
+# Search API Configuration
+SITE_SEARCH_API_BASE_URL = "https://search.rt5.ca/reptile_search/api/search/"
+SITE_SEARCH_SITE_KEY = "your-site-key-here"
+SITE_SEARCH_API_KEY = "your-api-key-here"  # Optional, if required by your API
+```
+
+### 3. URL Configuration
+
+Include the app's URLs in your main `urls.py`:
+
+```python
+from django.urls import path, include
+
+urlpatterns = [
+    # ... other URL patterns
+    path('search/', include('simplesitesearch.urls')),
+    # ... other URL patterns
+]
+```
+
+## Django CMS Integration
+
+### 1. Create a Search Page
+
+1. Log into your Django CMS admin
+2. Go to **Django CMS** > **Pages**
+3. Create a new page named "Search"
+4. Translate the title and slug in all languages
+5. Save and continue editing
+
+### 2. Configure the Page
+
+1. Go to **Advanced settings** of the search page
+2. Set the **ID** to `'search'`
+3. Set **APPLICATION** to "Site Search"
+4. Save the page
+5. Remove the page from the menu (uncheck "menu" in the table)
+6. Publish the page in all languages
+
+### 3. Access the Search
+
+Your search functionality will be available at the URL you configured for the search page.
+
+## Usage
+
+### Basic Search
+
+The search form accepts a `q` parameter for the search term:
+
+```
+/search/?q=your+search+term
+```
+
+### Pagination
+
+The search results support pagination with a `page` parameter:
+
+```
+/search/?q=your+search+term&page=2
+```
+
+### Honeypot Protection
+
+The search includes basic honeypot protection. If a `message` parameter is present, the search will not execute.
+
+## Customization
+
+### Templates
+
+The package includes two main templates:
+
+- `simplesitesearch/search_results.html` - Main search results template
+- `simplesitesearch/pagination.html` - Pagination template
+
+#### Template Customization
+
+You can override these templates in your project by creating templates with the same names in your template directory. The templates are designed to be easily customizable:
+
+**Template Include Paths:**
+- `simplesitesearch/search_results.html` - Main search results page
+- `simplesitesearch/pagination.html` - Pagination component (included in search_results.html)
+
+**To customize templates:**
+1. Create a `templates/simplesitesearch/` directory in your Django project
+2. Copy the template files from the package and modify them as needed
+3. Your custom templates will override the package defaults
+
+**Example template structure:**
+```
+your_project/
+├── templates/
+│   └── simplesitesearch/
+│       ├── search_results.html  # Your custom search results template
+│       └── pagination.html      # Your custom pagination template
+```
+
+### Styling
+
+The templates use Bootstrap classes and can be easily customized with CSS. The main CSS classes used are:
+
+- `.pagination` - Pagination container
+- `.search_query` - Search query display
+- `.search_results` - Results count display
+- `.wrapper_single_result` - Individual result container
+
+## API Response Format
+
+The search expects the API to return JSON in the following format:
+
+```json
+{
+    "total_hits": 42,
+    "hits": [
+        {
+            "title": "Page Title",
+            "url": "https://example.com/page/",
+            "highlight": "Search term highlighted content..."
+        }
+    ]
+}
+```
+
+## Requirements
+
+- Python 3.6+
+- Django 2.2+
+- django-cms 3.2+
+- requests 2.22.0+
+
+## Development
+
+### Local Development
+
+1. Clone the repository
+2. Install in development mode:
+   ```bash
+   pip install -e .
+   ```
+
+### Testing
+
+Run the tests with:
+
+```bash
+python manage.py test simplesitesearch
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+For support and questions, please open an issue on the [GitHub repository](https://github.com/yourusername/simplesitesearch/issues).
+
+## Changelog
+
+### 0.0.1.dev1
+- Initial development release
+- Django CMS integration
+- Pagination support
+- Multi-language support
+- Basic search functionality
+- Template customization support
+- Support for Python 3.6+ and Django 2.2+
+- Updated API endpoint to use Reptile Search API
+
+

simplesitesearch-0.0.1.dev1.dist-info/RECORD

@@ -0,0 +1,11 @@
+simplesitesearch/__init__.py,sha256=259yVYoZ0qRnvmlzBLwt-nqou6DtFCC-MRKbyW3LMnk,29
+simplesitesearch/cms_apps.py,sha256=Zp48MmxavV-s-7XbfkJmeYkPsFtOz8vsicgnWZT9Vz8,366
+simplesitesearch/urls.py,sha256=7M7rcMlglmVnVOOBUEmtlaH7BA7W2f3-7xB8hpiLm3Y,146
+simplesitesearch/views.py,sha256=FTKYdbh0MGEhjoGjYaHTKIPRxsBfO-CSh1I5S_nbCQw,4102
+simplesitesearch/templates/simplesitesearch/pagination.html,sha256=u3XrAaEIK922oCXTreN1cmzW6z3C8FSwu_e5xeZyHBM,1644
+simplesitesearch/templates/simplesitesearch/search_results.html,sha256=_HQV1i3vNOtJph83NDHvS9QozSceCdYIbI_kraltWxk,2130
+simplesitesearch-0.0.1.dev1.dist-info/licenses/LICENSE,sha256=dRZHhCf5a7ZSLSofyQQJJidW9mQ-uX3dwnph0tqrkhU,1077
+simplesitesearch-0.0.1.dev1.dist-info/METADATA,sha256=lEr2Ix_m1vD9pshRjmh8bDeNt0DD-rjrGCxtHOlD0Sw,7198
+simplesitesearch-0.0.1.dev1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+simplesitesearch-0.0.1.dev1.dist-info/top_level.txt,sha256=MKqY_-x--5g-Toif0DEYAoH8Wo71JTNj9pYLbzb778M,17
+simplesitesearch-0.0.1.dev1.dist-info/RECORD,,

simplesitesearch-0.0.1.dev1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

simplesitesearch-0.0.1.dev1.dist-info/licenses/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2024 Simple Site Search
+
+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.
+
+

simplesitesearch-0.0.1.dev1.dist-info/top_level.txt

@@ -0,0 +1 @@
+simplesitesearch