A PDF collection reader with built-in full-text search engine
Switch branches/tags
Nothing to show
Clone or download
Latest commit cd572cc May 27, 2017
Permalink
Failed to load latest commit information.
build Add pyinstaller setting for linux/Mac Mar 11, 2017
electron Enable search by enter key press May 27, 2017
images Add screenshot Mar 8, 2017
search Modify May 27, 2017
.gitignore Add elm-electron Jan 22, 2017
.travis.yml Fix ci setting Mar 14, 2017
LICENSE Create LICENSE Feb 1, 2017
README.md Edit readme May 27, 2017
appveyor.yml Add elm cache for win CI Mar 12, 2017

README.md

Mirusan

Build status: travis-ci Build status: appveyor

mirusan_logo.png

screenshot.png

A PDF collection reader with built-in full text search engine

Written in Python / Electron / Elm / Javascript

Features

  • Simple UI

  • Local database (You have controll 100% of your data)

  • Easy installation (No need to install external databases)

  • Multiplatform (Linux, Mac, Windows)

Installation

Prerequisites

Instructions

git clone https://github.com/mknz/mirusan.git

cd ./mirusan
cd ./search
pip install -r requirements.txt

cd ../electron
npm install
npm run compile

npm start

Language support

Mirusan automatically detects input language using Google's language-detection. Tokenizer or analyzer for indexing is chosen according to the detected language.

For following languages, Whoosh's built-in LanguageAnalayzer or StandardAnalyzer (for English) is used.

(though currently it does not work properly for Arabic.)

Arabic
Danish
Dutch
English
Finnish
French
German
Hungarian
Italian
Norwegian
Portuguese
Romanian
Russian
Spanish
Swedish
Turkish

For other languages, N-gram tokenizer (minsize=1, maxsize=2) is used.

License

GPLv3

Acknowledgements

Whoosh (Pure Python search engine library)

pdf.js

Electron

Photon

Elm

elm-electron