• Stars
    star
    299
  • Rank 139,269 (Top 3 %)
  • Language
    Python
  • License
    MIT License
  • Created over 9 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

RESTful search server written in Python, powered by SQLite.

scout is a RESTful search server written in Python. The search is powered by SQLite's full-text search extension, and the web application utilizes the Flask framework.

Scout aims to be a lightweight, RESTful search server in the spirit of ElasticSearch, powered by the SQLite full-text search extension. In addition to search, Scout can be used as a document database, supporting complex filtering operations. Arbitrary files can be attached to documents and downloaded through the REST API.

Scout is simple to use, simple to deploy and just works.

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.
  • Documentation hosted on ReadTheDocs.

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.

Alternatively, you can run scout using docker and the provided Dockerfile.

Installation using pip:

$ pip install scout

You can also install the latest master branch using pip:

$ 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:

$ 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 and peewee.

Check out the documentation for more information about the project.

Running scout

If you installed using pip, you should be able to simply run:

$ scout /path/to/search-index.db

If you've just got a copy of the source code, you can run:

$ python scout/ /path/to/search-index.db

Docker

To run scout using docker, you can use the provided Dockerfile or simply pull the coleifer/scout image from dockerhub:

$ docker run -it --rm -p 9004:9004 coleifer/scout
# scout is now running on 0.0.0.0:9004

Build your own image locally and run it:

$ cd scout/docker
$ docker build -t scout .
$ docker run -d \
    --name my-scout-server \
    -p 9004:9004 \
    -v scout-data:/data \
    scout

More Repositories

1

peewee

a small, expressive orm -- supports postgresql, mysql, sqlite and cockroachdb
Python
11,103
star
2

huey

a little task queue for python
Python
5,154
star
3

sqlite-web

Web-based SQLite database browser written in Python
Python
3,359
star
4

walrus

Lightweight Python utilities for working with Redis
Python
1,149
star
5

flask-peewee

flask integration for peewee, including admin, authentication, rest api and more
Python
776
star
6

micawber

a small library for extracting rich content from urls
Python
632
star
7

unqlite-python

Python bindings for the UnQLite embedded NoSQL database
C
389
star
8

django-relationships

Descriptive relationships between auth.users (think facebook friends and twitter followers, plus more)
Python
369
star
9

pysqlite3

SQLite3 DB-API 2.0 driver from Python 3, packaged separately, with improvements
C
184
star
10

irc

tinkering with a made-from-scratch irc library in python
Python
179
star
11

django-generic-m2m

relate anything to anything
Python
153
star
12

simpledb

miniature redis-like server implemented in Python
Python
138
star
13

python-lsm-db

Python bindings for the SQLite4 LSM database.
C
129
star
14

vedis-python

Python bindings for the Vedis embedded NoSQL database
C
125
star
15

wtf-peewee

WTForms integration for peewee
Python
111
star
16

sqlcipher3

Python 3 bindings for SQLCipher
C
85
star
17

sophy

Fast Python bindings to Sophia Database
C
80
star
18

django-generic-aggregation

annotate() and aggregate() for generically-related data.
Python
72
star
19

beefish

simple file encryption with pycrypto
Python
67
star
20

ucache

gametight lightweight caching library for python
Python
65
star
21

chrome-extensions

Personal collection of chrome extensions
JavaScript
61
star
22

sqlite-vtfunc

Implement SQLite table-valued functions with Python
Cython
58
star
23

sweepea

Fast, lightweight Python database toolkit for SQLite, built with Cython.
Cython
42
star
24

dot-theme

dotfile templating tools
Python
31
star
25

greendb

server frontend for lmdb
Python
25
star
26

kvkit

dank key/value store high-level APIs
Python
18
star
27

kt

Fast Python client for KyotoTycoon
Python
18
star
28

ukt

Kyoto Tycoon client library for Python.
Python
11
star
29

sqlite3-bloomfilter

Bloomfilter for SQLite3
C
6
star