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.16.tar.gz (44.2 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for ovp-search-1.0.16.tar.gz
Algorithm Hash digest
SHA256 51666802d091374857c369a854f554e9f190207b8ccdd888d2e93f8cf2ccc02e
MD5 5b61978001cc98170d5802cc5f102b2b
BLAKE2b-256 fb8fd0477e04e4ca9edb97c95d3d3d72176f2baf2ab06c840de99a532b73e005

See more details on using hashes here.

Supported by

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