Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2.98 KB

README.md

File metadata and controls

53 lines (35 loc) · 2.98 KB
Raw

SR PDF Crawler

This handy tool is used to quickly crawl through all the Shadowrun rulebooks you gathered over the years and give you that single pesky rule you just can't find.

At the initial startup an search index is built. This can take quite some time, especially on older systems. Afterwards the search is very fast.

Screenshot of the first Release

How - To

I try to provide simple one-click solutions for Windows and Linux. The program does not need to be installed, so take care where you place the executable !

  • Head over to Releases and download the latest Release
  • Run the executable:
    • Windows: Doubleclick srpdfcrawler.exe
    • Linux: chmod a+x srpdfcrawler; ./srpdfcrawler

That's it ! Be warned though - the first startup will take quite some time. Don't close it, just wait until you're prompted for the location of the rulebooks. Then the pdfs are merged into a database and the search index is build.
When done you're ready to search ! Every subsequent start should be fast !

Building

Build instructions are only relevant for developers and summarize the steps required while giving information on tangential issues.

  • Check this for Windows textract : deanmalmgren/textract#111

    • Download the linked zip and extract pdftotext.exe to the programs root
    • Add the file to the pyinstaller spec like this : datas=[('pdftotext.exe', '.')],

  • Add an hidden import for textract: hiddenimports=["textract.parsers.pdf_parser"],

  • pip install https://github.com/pyinstaller/pyinstaller/archive/develop.zip (PyInstaller currently does not support Python 3.6 on stable.)

  • Read through pyinstaller/pyinstaller#1566 and make sure you have done the following if on Windows:

      The following solved the problem for me (on Win10 v1607 - PyQt5 App):

  Add the directory of the required dlls to system Path. My application uses PyQt5 which is dependent on api-ms-win dlls.

  For PyQt5 add this directory: %WHERE EVER YOU INSTALLED PYTHON%\Lib\site-packages\PyQt5\Qt\bin

  For api-ms-win dlls you need Visual Studio 2015 OR Windows SDK (download here):
  Directory if you have Visual Studio: C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\Remote Debugger\x64
  Directory if you have Windows SDK: C:\Program Files (x86)\Windows Kits\10\Redist\ucrt\DLLs\x64

    After you add the required paths, pyinstaller can find the files.

  • Build using pyinstaller gui_onefile.spec or pyinstaller gui_onedir.spec after adjusting paths in them.

Common issues

  • Recursion issues : Add the following to gui.spec

    import sys
sys.setrecursionlimit(10000)

  • Failed to execute pyi_rth_qt5plugins

    • Add your PyQt5-Path to pathex in the spec file e.g. C:\Users\ricc\AppData\Local\Programs\Python\Python36\Lib\site-packages

  • Problems with textract : See deanmalmgren/textract#156