Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

scout

Project Description

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

[scout](http://scout.readthedocs.org/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](http://scout.readthedocs.org/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](http://scout.readthedocs.org/en/latest/) for more information about the project.

Release History

Release History

This version
History Node

0.4.0

History Node

0.3.1

History Node

0.3.0

History Node

0.2.1

History Node

0.2.0

History Node

0.1.6

History Node

0.1.5

History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
scout-0.4.0.tar.gz (21.7 kB) Copy SHA256 Checksum SHA256 Source Mar 15, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting