Skip to main content

Python utilities for LENS, a local-first qualitative data analysis (QDA) tool.

Project description

lens-qda

Python utilities for LENS, a local-first qualitative data analysis (QDA) desktop application.

This package bundles the same PDF text-extraction pipeline that the LENS desktop app uses to ingest PDF documents, exposing it as a small CLI so it can also be used directly from Python or from shell scripts.

Install

pip install lens-qda

Requires Python 3.8+ and the prebuilt wheels for pdfplumber and its dependencies (cryptography, pillow, pdfminer.six, ...) on PyPI; no compiler is needed on supported platforms.

CLI usage

# Print plain text extracted from a PDF (one paragraph per page):
lens-qda extract path/to/paper.pdf

# Emit the same JSON envelope the LENS desktop sidecar produces:
lens-qda extract paper.pdf --json

# Save the extracted text to a file:
lens-qda extract paper.pdf -o paper.txt

# Tune pdfplumber's tolerances (defaults match the sidecar):
lens-qda extract paper.pdf --x-tolerance 3 --y-tolerance 3

The --json schema matches the contract the LENS Tauri sidecar already implements:

{ "success": true, "text": "...all pages, joined by blank lines..." }

On failure:

{ "success": false, "error": "<exception message>" }

(the process exits with status 1 in that case).

Programmatic usage

from pathlib import Path
import json, subprocess

result = subprocess.run(
    ["lens-qda", "extract", "paper.pdf", "--json"],
    capture_output=True, text=True, check=True,
)
envelope = json.loads(result.stdout)
assert envelope["success"], envelope["error"]
corpus = envelope["text"]

License

MIT — same as the parent LENS project.

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

lens_qda-0.2.1.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

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

lens_qda-0.2.1-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file lens_qda-0.2.1.tar.gz.

File metadata

  • Download URL: lens_qda-0.2.1.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for lens_qda-0.2.1.tar.gz
Algorithm Hash digest
SHA256 e0b76db35d1e699516cc20145674d936935ba01ad551ca7625c3ee5684c6188d
MD5 8c2ff44946395156d25676cb332d3c7c
BLAKE2b-256 0c558491a743bc5d21804bd6b076b4497858fe6941a250ce66518422e88c30db

See more details on using hashes here.

Provenance

The following attestation bundles were made for lens_qda-0.2.1.tar.gz:

Publisher: release.yml on mabo-du/lens

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lens_qda-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: lens_qda-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for lens_qda-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b19f747f5efe26732c8504506e3656cc8ca871c7473e8a5c91e01ff1a9003e66
MD5 7df7d85e2633e6292fb5335c5a14fb00
BLAKE2b-256 519aea4e396cdb629f9b99277201a43b90baa1b90538f0ee66a97e53f3988321

See more details on using hashes here.

Provenance

The following attestation bundles were made for lens_qda-0.2.1-py3-none-any.whl:

Publisher: release.yml on mabo-du/lens

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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