Skip to main content

scout - a lightweight search server powered by SQLite

Project description

![](http://media.charlesleifer.com/blog/photos/scout-logo.png)

[scout](https://scout.readthedocs.io/en/latest/) is a RESTful search server written in Python. The search is powered by [SQLite’s full-text search extension](http://sqlite.org/fts3.html), and the web application utilizes the [Flask](http://flask.pocoo.org) framework.

Features:

  • Multiple search indexes present in a single database.

  • RESTful design for easy indexing and searching.

  • Simple key-based authentication (optional).

  • Lightweight, low resource utilization, minimal setup required.

  • Store search content and arbitrary metadata.

  • Multiple result ranking algorithms, porter stemmer.

  • Besides full-text search, perform complex filtering based on metadata values.

  • Comprehensive unit-tests.

  • Supports SQLite [FTS4](http://sqlite.org/fts3.html) and the brand-new [FTS5](http://sqlite.org/fts5.html).

  • [Documentation hosted on ReadTheDocs](https://scout.readthedocs.io/en/latest/).

## Installation

Scout can be installed from PyPI using pip or from source using git. Should you install from PyPI you will run the latest version, whereas installing from git ensures you have the latest changes.

Installation using pip:

`console $ pip install scout `

You can also install the latest master branch using pip:

`console $ pip install -e git+https://github.com/coleifer/scout.git#egg=scout `

If you wish to install from source, first clone the code and run setup.py install:

`console $ git clone https://github.com/coleifer/scout.git $ cd scout/ $ python setup.py install `

Using either of the above methods will also ensure the project’s Python dependencies are installed: [flask](http://flask.pocoo.org) and [peewee](http://docs.peewee-orm.com).

[Check out the documentation](https://scout.readthedocs.io/en/latest/) for more information about the project.

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

scout-3.0.0.tar.gz (21.6 kB view hashes)

Uploaded source

Supported by

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