README
Presentation
irspdf is a simple textual information retrieval system for pdf documents.
Text is extracted from pdf with pdfplumber.
Standard text preprocessing for information retrieval is applied:
- StopWord removal
- Stemming
- Punctuation removal
- Lowercase conversion
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
Useful links
Documentation: https://irspdf.readthedocs.io/en/latest/.
Source Code: https://github.com/Jibril-Frej/irspdf
Package: https://pypi.org/project/irspdf/
1 maintainer
Metadata
1 maintainer
Release files for irspdf 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| irspdf-0.4.1.tar.gz | 4.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| irspdf-0.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.9 kB
Release files / irspdf-0.4.1.tar.gz
| Download URL | irspdf-0.4.1.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ce4d1a5e69667472b92ae114d32c0ad9c7532bb31c9970344ae890c23dfa2546
|
|
BLAKE2b-256 checksum How to use checksums |
18dd5bfba04a0c58535eeea6060904bbde40c9fccfe68e8447f9eaf416dd428b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6
|
Release files / irspdf-0.4.1-py3-none-any.whl
| Download URL | irspdf-0.4.1-py3-none-any.whl |
|---|---|
| Size | 5.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7dd0f1788bd2b96c00bad93314b5fbd785ad5ec5c9358636385cffe919dd76bb
|
|
BLAKE2b-256 checksum How to use checksums |
223db0e67766be06d6f37895993e562fd25f78d9914fb05b2845392d28b0a5dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6
|
Security for irspdf 0.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
