Metadata-Version: 2.4
Name: dumbwebsearch
Version: 0.1.0
Summary: dumb web interface to search/browse indexed text files
Project-URL: Homepage, https://gitlab.com/hydrargyrum/dumbsearch
Author-email: Hg <dev@indigo.re>
License-Expression: WTFPL
Keywords: search,server,web
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Bottle
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
Classifier: License :: Public Domain
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Requires-Python: >=3
Requires-Dist: bottle
Requires-Dist: jinja2
Description-Content-Type: text/markdown

# dumb web search

- index a directory of text files in sqlite database
- web browse this directory
- web search this directory with indexed text

## how to run

```
./index.py --docroot /path/to/markdown/dir --database /path/to/database.sqlite index

HTTP_SERVER_BASEURL=/reverse/proxy/subpath HTTP_SERVER_PORT=1234 INDEX_DIR=/path/to/markdown/dir INDEX_DATABASE=/path/to/database.sqlite ./browse.wsgi
```

## requirements

- python3
- sqlite to index/search text
- wsgi to expose said app
- jinja2 + bottle as web framework
- pandoc

## security

- no authentication: put a reverse proxy in front of it with some login
- no optimization for performance: put a reverse proxy to prevent hammering
- pandoc is run to render markdown files, which may have its own problems

## what could be better done

- don't make markdown so much ingrained in this app
