{"id":13464697,"url":"https://github.com/coleifer/scout","last_synced_at":"2025-05-15T17:03:53.212Z","repository":{"id":29361005,"uuid":"32895484","full_name":"coleifer/scout","owner":"coleifer","description":"RESTful search server written in Python, powered by SQLite.","archived":false,"fork":false,"pushed_at":"2024-10-15T14:52:10.000Z","size":194,"stargazers_count":310,"open_issues_count":0,"forks_count":26,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-05-08T14:46:28.936Z","etag":null,"topics":["flask","full-text-search","python","search","search-engine","sqlite"],"latest_commit_sha":null,"homepage":"http://scout.readthedocs.org/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coleifer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-03-25T22:49:52.000Z","updated_at":"2025-04-18T20:40:13.000Z","dependencies_parsed_at":"2024-11-13T01:00:53.544Z","dependency_job_id":"a834733b-11b3-4e2b-bfd0-aa21a41e8baa","html_url":"https://github.com/coleifer/scout","commit_stats":{"total_commits":158,"total_committers":4,"mean_commits":39.5,"dds":0.08860759493670889,"last_synced_commit":"846b1d4600f720a1026e8327f60bce1bf4448269"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coleifer%2Fscout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coleifer%2Fscout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coleifer%2Fscout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coleifer%2Fscout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coleifer","download_url":"https://codeload.github.com/coleifer/scout/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254384983,"owners_count":22062422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","full-text-search","python","search","search-engine","sqlite"],"created_at":"2024-07-31T14:00:48.829Z","updated_at":"2025-05-15T17:03:53.181Z","avatar_url":"https://github.com/coleifer.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"![](http://media.charlesleifer.com/blog/photos/scout-logo.png)\n\n[scout](https://scout.readthedocs.io/en/latest/) is a RESTful search server\nwritten in Python. The search is powered by [SQLite's full-text search extension](http://sqlite.org/fts3.html),\nand the web application utilizes the [Flask](http://flask.pocoo.org) framework.\n\nScout aims to be a lightweight, RESTful search server in the spirit of\n[ElasticSearch](https://www.elastic.co), powered by the SQLite full-text search\nextension. In addition to search, Scout can be used as a document database,\nsupporting complex filtering operations. Arbitrary files can be attached to\ndocuments and downloaded through the REST API.\n\nScout is simple to use, simple to deploy and *just works*.\n\nFeatures:\n\n* Multiple search indexes present in a single database.\n* RESTful design for easy indexing and searching.\n* Simple key-based authentication (optional).\n* Lightweight, low resource utilization, minimal setup required.\n* Store search content and arbitrary metadata.\n* Multiple result ranking algorithms, porter stemmer.\n* Besides full-text search, perform complex filtering based on metadata values.\n* Comprehensive unit-tests.\n* Supports SQLite [FTS4](http://sqlite.org/fts3.html).\n* [Documentation hosted on ReadTheDocs](https://scout.readthedocs.io/en/latest/).\n\n![](https://api.travis-ci.org/coleifer/scout.svg?branch=master)\n\n## Installation\n\nScout can be installed from PyPI using `pip` or from source using `git`. Should\nyou install from PyPI you will run the latest version, whereas installing from\n`git` ensures you have the latest changes.\n\nAlternatively, you can run `scout` using [docker](https://www.docker.com/) and\nthe provided [Dockerfile](https://github.com/coleifer/scout/blob/master/docker/Dockerfile).\n\nInstallation using pip:\n\n```console\n$ pip install scout\n```\n\nYou can also install the latest `master` branch using pip:\n\n```console\n$ pip install -e git+https://github.com/coleifer/scout.git#egg=scout\n```\n\nIf you wish to install from source, first clone the code and run `setup.py install`:\n\n```console\n$ git clone https://github.com/coleifer/scout.git\n$ cd scout/\n$ python setup.py install\n```\n\nUsing either of the above methods will also ensure the project's Python\ndependencies are installed: [flask](http://flask.pocoo.org) and\n[peewee](http://docs.peewee-orm.com).\n\n[Check out the documentation](https://scout.readthedocs.io/en/latest/) for more information about the project.\n\n## Running scout\n\nIf you installed using `pip`, you should be able to simply run:\n\n```console\n$ scout /path/to/search-index.db\n```\n\nIf you've just got a copy of the source code, you can run:\n\n```console\n$ python scout/ /path/to/search-index.db\n```\n\n## Docker\n\nTo run scout using docker, you can use the provided Dockerfile or simply pull\nthe `coleifer/scout` image from dockerhub:\n\n```console\n\n$ docker run -it --rm -p 9004:9004 coleifer/scout\n# scout is now running on 0.0.0.0:9004\n```\n\nBuild your own image locally and run it:\n\n```console\n\n$ cd scout/docker\n$ docker build -t scout .\n$ docker run -d \\\n    --name my-scout-server \\\n    -p 9004:9004 \\\n    -v scout-data:/data \\\n    scout\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoleifer%2Fscout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoleifer%2Fscout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoleifer%2Fscout/lists"}