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.

Source Distribution

ovp-search-1.0.8.tar.gz (35.5 kB view details)

Uploaded Source

File details

Details for the file ovp-search-1.0.8.tar.gz.

File metadata

  • Download URL: ovp-search-1.0.8.tar.gz
  • Upload date:
  • Size: 35.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ovp-search-1.0.8.tar.gz
Algorithm Hash digest
SHA256 b55959a4a5941800c92d6210770cdf7b5afc27b21c4f876570b4844858254da1
MD5 85c6bc7b3120c1bd98554a1ed987cf16
BLAKE2b-256 aa6667f68c3ceb98cabb4c691dfd58f23fb666c3cf21fe0ac4f755db67ced850

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page