{"id":27231359,"url":"https://github.com/dtrckd/docsearch","last_synced_at":"2025-06-12T23:03:52.215Z","repository":{"id":86309974,"uuid":"228021368","full_name":"dtrckd/docsearch","owner":"dtrckd","description":"Full text search in your pdf documents.","archived":false,"fork":false,"pushed_at":"2022-06-02T11:23:28.000Z","size":21,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T14:07:14.885Z","etag":null,"topics":["cli","search-engine"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dtrckd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-14T12:43:50.000Z","updated_at":"2022-06-02T11:22:29.000Z","dependencies_parsed_at":"2023-03-13T09:44:08.207Z","dependency_job_id":null,"html_url":"https://github.com/dtrckd/docsearch","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dtrckd/docsearch","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtrckd%2Fdocsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtrckd%2Fdocsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtrckd%2Fdocsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtrckd%2Fdocsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dtrckd","download_url":"https://codeload.github.com/dtrckd/docsearch/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtrckd%2Fdocsearch/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259546413,"owners_count":22874560,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","search-engine"],"created_at":"2025-04-10T13:44:26.121Z","updated_at":"2025-06-12T23:03:52.208Z","avatar_url":"https://github.com/dtrckd.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docsearch\n\n**Docsearch** is a self-hosted search engine for your pdf documents based on [pmk](https://github.com/dtrckd/pymake) and [Whoosh](https://github.com/mchaput/whoosh).\n\n# Install\n\nYou may need the following packages: `apt-get install poppler-utils default-jdk`\n\nClone the repo and enter inside:\n\n    make setup\n\n# Overview\n\nThis repo provide **Search Engine** experience which follows the pymake design pattern.\n\nThe context of this [Pymake](https://github.com/dtrckd/pymake) program is as follows:\n* **Data**: documents to search-in are pdf documents (like articles for example), located in your hardrive,\n* **Model**: A BM25 model, that assumes a information model of bag of words representation.\n* **Script**: There are two scripts:\n    + a fit script that builds the index of the *input data*,\n    + a search script that returns relevant documents, given a *query*.\n* Experiment **Spec** are defined individually for each scripts in the attribute `_default_expe` in the class headers.\n\n\n# Usage\n\n\n#### The \"fit\" script\n\nFirst, index your pdf documents (take a coffee)\n\n    pmk -x fit --path path/to/your/pdfs/   \n\nAlternatively, you can turn on features extraction (much slower), using [cermine](cermine.ceon.pl).\n\n    # To index trying to extract title, authors and publication date.\n    pmk -x fit --path path/to/your/pdfs/ --extract-feature\n\n\n#### The \"search\" script\n\nThen, search documents based on text content\n\n    pmk -x search \"your text search request\"\n\n\nShow only the first match:\n\n    pmk -x search \"your text search request\" --limit 1\n\n\n# Pymake tips\n\nList information about the project :\n\n* What experiments are there: `pmk -l spec`\n* What models are there: `pmk -l model`\n* What scripts are there: `pmk -l script`\n* Show signatures of methods in scripts ('ir' script)\\: `pmk -l --script ir`\n\nTo add new models, new scripts, or specs, you need to create them in the dedicated folder following the base class implementations.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdtrckd%2Fdocsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdtrckd%2Fdocsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdtrckd%2Fdocsearch/lists"}