Skip to main content

This module has search functionality for ovp projects and nonprofits

Project description

https://img.shields.io/codeship/58b28a40-7d1d-0134-1441-32b74bfe7659/master.svg?style=flat-square https://img.shields.io/codecov/c/github/OpenVolunteeringPlatform/django-ovp-search.svg?style=flat-square https://img.shields.io/pypi/v/ovp-search.svg?style=flat-square

This module implements core search functionality. It is responsible for searching projects and nonprofits.

Getting Started

Prerequisites

This module relies on django-haystack to do full-text search. It was implemented and tested on top of ElasticSearch but should work with any backend.

Installing

  1. Install django-ovp-search:

    pip install ovp-search
    
  2. Add it to INSTALLED_APPS on settings.py

  3. Add haystack to INSTALLED_APPS

  4. Set up haystack connection:

    HAYSTACK_CONNECTIONS = {
      'default': {
        'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
        'URL': 'http://%s/' % (os.environ.get('HS_SEARCH_ENDPOINT', '127.0.0.1:9200')),
        'INDEX_NAME': 'atadosovp'
      },
    }
    

Forking

If you have your own OVP installation and want to fork this module to implement custom features while still merging changes from upstream, take a look at django-git-submodules.

Testing

To test this module

python ovp_searcb/tests/runtests.py

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the AGPLv3 License see the LICENSE.md file for details

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
ovp-search-1.0.16.tar.gz (44.2 kB) Copy SHA256 hash SHA256 Source None Jun 22, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page