txpyfind 1.4.0

enables Pythonic access to data exports from TYPO3-find

txpyfind enables access to data exports from TYPO3-find in Python. Details on the TYPO3-find setup required for data exports can be found in the section Data export in the README file of that repository.

The three JSON formats json-all, json-solr-results and raw-solr-response are already available in the TYPO3 extension, see the partials used to create the three formats.

You can use the client class available in this Python package to query these exports. A simple parser for the returned JSON objects is also available.

See slubfind for a real-world implementation example, including custom query types and instance-specific response parsing.

Installation

… via PyPI

pip install txpyfind

… or from GitHub source

pip install git+https://github.com/slub/txpyfind.git

Command-Line Usage

After installation, the txpyfind command is available (also via python -m txpyfind).

Query

Execute a search query:

txpyfind --url https://katalog.slub-dresden.de query "manfred bonitz"

With a facet filter and pagination:

txpyfind --url https://katalog.slub-dresden.de query "python" --facet format_de14="Book, E-Book" --page 1 --count 10

Multiple --facet options can be combined:

txpyfind --url https://katalog.slub-dresden.de query "python" --facet format_de14="Book, E-Book" --facet language=German

Query Type

Use --type to select a query type (e.g. author, title). Valid values depend on the TYPO3-find instance. Use --query-type (repeatable) to whitelist the types accepted by --type; if omitted, only default is allowed:

txpyfind --url https://katalog.slub-dresden.de query --query-type default --query-type author --query-type title --type author "bonitz"

Document

Fetch a single document by ID:

txpyfind --url https://katalog.slub-dresden.de document --document-path id --export-format json-ld 0-1132486122

Scroll

Fetch all results for a query:

txpyfind --url https://katalog.slub-dresden.de scroll "manfred bonitz" --batch 10

Stream results as JSONL (one JSON object per line), useful for piping:

txpyfind --url https://katalog.slub-dresden.de scroll "manfred bonitz" --stream | jq .id

Show Request URL

Use --show-url to print the request URL instead of fetching the response. This works with all subcommands:

txpyfind --url https://katalog.slub-dresden.de --show-url query "python" --facet format_de14="Book, E-Book"
txpyfind --url https://katalog.slub-dresden.de --show-url document --document-path id --export-format json-ld 0-1132486122
txpyfind --url https://katalog.slub-dresden.de --show-url scroll "python" --batch 10

Export Format

Use --export-format on the query subcommand to select the response format (default: raw-solr-response). On the document subcommand, --export-format is required and has no default. The three formats built into TYPO3-find are raw-solr-response, json-all, and json-solr-results:

txpyfind --url https://katalog.slub-dresden.de query --export-format json-solr-results "manfred bonitz"

Environment Variable

Set TXPYFIND_URL to avoid repeating the --url option:

export TXPYFIND_URL=https://katalog.slub-dresden.de
txpyfind query "manfred bonitz"
txpyfind document --document-path id --export-format json-ld 0-1132486122

Python Usage Example

from txpyfind.client import Find
# create Find instance
slub_find = Find("https://katalog.slub-dresden.de", document_path="id", export_format="json-ld")
# retrieve JSON-LD data (detail view)
slub_ld_doc = slub_find.get_document("0-1132486122")
# retrieve JSON-LD data (query view)
slub_ld_q_default = slub_find.get_query("manfred bonitz")
# query with a single facet (dict)
slub_find.get_query("python", facet={"format_de14": "Book, E-Book"})
# query with multiple facets (list of dicts)
slub_find.get_query("python", facet=[{"format_de14": "Book, E-Book"}, {"language": "German"}])

License

This project is licensed under the GNU General Public License v3 (GPLv3). See the LICENSE file for the full license text.