Skip to main content

A simple information retrieval system for pdf documents

Project description

irspdf

A simple textual information retrieval system for pdf documents.

The ranking function used is BM25.

Installation

Install with pip

pip install irspdf

OR install from github

git clone https://github.com/Jibril-Frej/irspdf.git
cd irspdf && python setup.py install

Usage

Build a collection

from irspdf import build
build(folder_path, collection_path)

folder_path : path of the folder that contains all the pdf files to include to the collection.

collection_path : file where the collection will be saved

Query the collection

from irspdf import query
query(collection_path)

collection_path : file where the collection is saved

Update the collection

from irspdf import update
update(folder_path, collection_path)

folder_path : path of the folder that contains all the pdf files to add to the collection.

collection_path : file where the original collection is saved

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

irspdf-0.3.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

irspdf-0.3.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file irspdf-0.3.0.tar.gz.

File metadata

  • Download URL: irspdf-0.3.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for irspdf-0.3.0.tar.gz
Algorithm Hash digest
SHA256 95f36b44173e2300cefd1bfb99c5506ee248f2b0ffe678d3c655e3f4600125e2
MD5 9bf48abfa7772cf9e2fa3455f43bee1c
BLAKE2b-256 0cc4260e177760f8db3a9894d5367267f3032b8be4ac0f072207f103c6c59187

See more details on using hashes here.

File details

Details for the file irspdf-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: irspdf-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for irspdf-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6035a4a07b9e4b92b12c41307362e3161b5bafbadf407261aa2baa6b8f84af5c
MD5 8c296108eac7f1b5da0b628bec514050
BLAKE2b-256 90e4e7a21baab9f6a820bfd1f177ea4a9d8822ee99750fad175cebc8e38e6569

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page