slubfind 0.1.0__tar.gz

slubfind-0.1.0/.github/workflows/pypi.yml

@@ -0,0 +1,33 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel build twine
+        pip install -r requirements.txt
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python -m build .
+        twine upload dist/*

slubfind-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version:  ${{ matrix.python-version }}
+    - name: Lint with flake8
+      run: |
+        pip install flake8
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 slubfind --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 slubfind --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Install package
+      run: pip install .
+    - name: Install dependencies for test
+      run: pip install pytest coverage
+    - name: Run test and coverage
+      run: |
+        coverage erase
+        coverage run -m pytest test
+        coverage report
+        coverage html

slubfind-0.1.0/.gitignore

@@ -0,0 +1,151 @@
+# generated by setuptools-scm
+slubfind/_version.py
+
+# Development files / directories
+_/
+dev/
+*-dev
+*-dev.*
+dev-*
+dev.*
+
+# Editor
+*.swp
+*.swo
+*~
+.vscode
+
+# Data
+*.json
+
+# <https://github.com/github/gitignore/blob/master/Python.gitignore>
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

slubfind-0.1.0/CHANGELOG

@@ -0,0 +1,5 @@
+0.1.0 [2025-06-01]
+- first published release
+
+0.0.0 [2023-08-01]
+- initial commit

slubfind-0.1.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.1
+Name: slubfind
+Version: 0.1.0
+Summary: query data exports from the SLUB catalogue
+Author: Donatus Herre
+Author-email: donatus.herre@slub-dresden.de
+License: GPLv3
+Project-URL: homepage, https://github.com/slub/slubfind
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: txpyfind
+
+========
+slubfind
+========
+
+With ``slubfind`` you can query data exports from the `SLUB catalogue <https://katalog.slub-dresden.de>`_
+in Python.
+
+This package is based on `txpyfind <https://github.com/slub/txpyfind>`_,
+which enables access to data exports from `TYPO3-find <https://github.com/subugoe/typo3-find>`_.
+
+Installation
+============
+
+... via PyPI
+~~~~~~~~~~~~
+
+.. code-block:: bash
+
+   pip install slubfind
+
+... or from Github source
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+   pip install git+https://github.com/slub/slubfind.git
+
+
+Usage Example
+=============
+
+.. code-block:: python
+
+   from slubfind.client import SlubFind
+   # create SlubFind instance
+   slub_find = SlubFind()
+   # retrieve JSON data (query view, app format)
+   slub_q = slub_find.app_search("manfred bonitz")
+   # retrieve JSON data (detail view, app format)
+   slub_doc = slub_find.app_document("0-1132486122")

slubfind-0.1.0/README.rst

@@ -0,0 +1,40 @@
+========
+slubfind
+========
+
+With ``slubfind`` you can query data exports from the `SLUB catalogue <https://katalog.slub-dresden.de>`_
+in Python.
+
+This package is based on `txpyfind <https://github.com/slub/txpyfind>`_,
+which enables access to data exports from `TYPO3-find <https://github.com/subugoe/typo3-find>`_.
+
+Installation
+============
+
+... via PyPI
+~~~~~~~~~~~~
+
+.. code-block:: bash
+
+   pip install slubfind
+
+... or from Github source
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+   pip install git+https://github.com/slub/slubfind.git
+
+
+Usage Example
+=============
+
+.. code-block:: python
+
+   from slubfind.client import SlubFind
+   # create SlubFind instance
+   slub_find = SlubFind()
+   # retrieve JSON data (query view, app format)
+   slub_q = slub_find.app_search("manfred bonitz")
+   # retrieve JSON data (detail view, app format)
+   slub_doc = slub_find.app_document("0-1132486122")

slubfind-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = [
+         "setuptools>=42",
+         "setuptools_scm[toml]",
+         "wheel",
+]  # PEP 508 specifications.
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "slubfind"
+description = "query data exports from the SLUB catalogue"
+readme = "README.rst"
+authors = [
+        {name = "Donatus Herre"},
+        {email = "donatus.herre@slub-dresden.de"}
+]
+license = {text = "GPLv3"}
+keywords = []
+classifiers = [
+            "Programming Language :: Python :: 3",
+            "Operating System :: OS Independent",
+            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+            "Development Status :: 3 - Alpha",
+            "Intended Audience :: Developers",
+            "Intended Audience :: Education",
+            "Intended Audience :: Science/Research",
+            "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dynamic = ["version", "dependencies"]
+requires-python = ">=3.7"
+
+[project.urls]
+homepage = "https://github.com/slub/slubfind"
+
+[project.scripts]
+#slubfind = "slubfind.cli:cli"
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+[tool.setuptools_scm]
+write_to = "slubfind/_version.py"

slubfind-0.1.0/requirements.txt

@@ -0,0 +1 @@
+txpyfind

slubfind-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

slubfind-0.1.0/slubfind/__init__.py

@@ -0,0 +1,7 @@
+"""
+With ``slubfind`` you can query data exports from the SLUB catalogue.
+"""
+from . import client, parser
+from ._version import __version__, version, version_tuple
+
+__all__ = ["client", "parser", "__version__", "version", "version_tuple"]

slubfind-0.1.0/slubfind/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)

slubfind-0.1.0/slubfind/client.py

@@ -0,0 +1,188 @@
+"""
+client module of ``slubfind`` package
+"""
+import re
+from txpyfind import utils
+from txpyfind.client import Find
+from txpyfind.parser import JSONResponse
+
+from .parser import AppDetails
+
+
+class SlubFind(Find):
+    """
+    ``SlubFind`` class from ``slubfind.client`` module
+    """
+
+    def __init__(
+            self,
+            base_url="https://katalog.slub-dresden.de",
+            export_format="app",
+            export_page=1369315142,
+            parser_class=JSONResponse):
+        super().__init__(
+            base_url,
+            document_path="id",
+            query_types=[
+                "default",
+                "author",
+                "title",
+                "topic",
+                "barcode",
+                "ident",
+                "rvk_facet",
+                "signatur",
+                "imprint",
+                "series2",
+                "provenance"
+            ],
+            facets=[
+                "facet_avail",
+                "format_de14",
+                "publishDateSort",
+                "branch_collcode",
+                "branch",
+                "license",
+                "access_state",
+                "language",
+                "thema",
+                "author",
+                "facet_music_notation_de14",
+                "music_heading_browse",
+                "provenance",
+                "mega_collection"
+            ],
+            count_limit=1000,
+            sort_pattern=re.compile(
+                r"^(score|publishDateSort|title_sort|id)[+ ](asc|desc)$"),
+            export_format=export_format,
+            export_page=export_page,
+            parser_class=parser_class)
+
+    def app_document(
+            self,
+            document_id,
+            type_num=None):
+        """
+        fetch detail view in app format
+        """
+        return self.get_document(
+            document_id,
+            data_format="app",
+            type_num=type_num,
+            parser_class=AppDetails)
+
+    def app_search(
+            self,
+            query,
+            qtype="default",
+            facet=None,
+            page=0,
+            count=0,
+            sort="",
+            type_num=None,
+            parser_class=None):
+        """
+        fetch query view in app format
+        """
+        return self.get_query(
+            query,
+            qtype=qtype,
+            facet=facet,
+            page=page,
+            count=count,
+            sort=sort,
+            data_format="app",
+            type_num=type_num,
+            parser_class=parser_class)
+
+    def settings(self):
+        """
+        get the settings used for TYPO3-find
+        """
+        url = self.url_query(
+            "qqqqq",
+            qtype="default",
+            facet=None,
+            page=0,
+            count=0,
+            sort="",
+            data_format="json-all",
+            type_num=None)
+        response = utils.json_request(url)
+        if isinstance(response, dict) and "settings" in response:
+            return response["settings"]
+        return None
+
+    def solr_params(
+            self,
+            query,
+            qtype="default",
+            facet=None,
+            page=0,
+            count=0,
+            sort="",
+            type_num=None):
+        """
+        get the parameters used for the Solr request
+        """
+        url = self.url_query(
+            query=query,
+            qtype=qtype,
+            facet=facet,
+            page=page,
+            count=count,
+            sort=sort,
+            data_format="json-solr-params",
+            type_num=type_num)
+        url = utils.add_tx_param(url, "omitHeader", "false")
+        response = utils.json_request(url)
+        if isinstance(response, dict):
+            return response
+        return None
+
+    def solr_params_via_url(
+            self,
+            url,
+            type_num=None):
+        """
+        get the parameters used for the Solr request via given TYPO3-find URL
+        """
+        url = self.url_parser(url)
+        if url.is_ok:
+            return self.solr_params(
+                url.query,
+                qtype=url.qtype,
+                facet=url.facets,
+                page=url.page,
+                count=url.count,
+                sort=url.sort,
+                type_num=type_num)
+        return None
+
+    def solr_request(
+            self,
+            query,
+            qtype="default",
+            facet=None,
+            page=0,
+            count=0,
+            sort="",
+            type_num=None):
+        """
+        get the URL of the Solr request
+        """
+        url = self.url_query(
+            query=query,
+            qtype=qtype,
+            facet=facet,
+            page=page,
+            count=count,
+            sort=sort,
+            data_format="json-solr-request",
+            type_num=type_num)
+        url = utils.add_tx_param(url, "debug", "1")
+        response = utils.json_request(url)
+        if isinstance(response, dict) and "url" in response:
+            return response["url"]
+        return None

slubfind-0.1.0/slubfind/parser.py

@@ -0,0 +1,16 @@
+"""
+parser module of ``slubfind``
+"""
+from txpyfind.parser import JSONResponse
+
+
+class AppDetails(JSONResponse):
+    """
+    ``AppDetails`` class from ``slubfind.parser`` module
+    """
+
+    def __init__(self, plain):
+        super().__init__(plain)
+        self.ok = isinstance(self.raw, dict) and "id" in self.raw
+        self.found = self.ok and isinstance(
+            self.raw["id"], str) and len(self.raw["id"].strip()) > 0

slubfind-0.1.0/slubfind.egg-info/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.1
+Name: slubfind
+Version: 0.1.0
+Summary: query data exports from the SLUB catalogue
+Author: Donatus Herre
+Author-email: donatus.herre@slub-dresden.de
+License: GPLv3
+Project-URL: homepage, https://github.com/slub/slubfind
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: txpyfind
+
+========
+slubfind
+========
+
+With ``slubfind`` you can query data exports from the `SLUB catalogue <https://katalog.slub-dresden.de>`_
+in Python.
+
+This package is based on `txpyfind <https://github.com/slub/txpyfind>`_,
+which enables access to data exports from `TYPO3-find <https://github.com/subugoe/typo3-find>`_.
+
+Installation
+============
+
+... via PyPI
+~~~~~~~~~~~~
+
+.. code-block:: bash
+
+   pip install slubfind
+
+... or from Github source
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+   pip install git+https://github.com/slub/slubfind.git
+
+
+Usage Example
+=============
+
+.. code-block:: python
+
+   from slubfind.client import SlubFind
+   # create SlubFind instance
+   slub_find = SlubFind()
+   # retrieve JSON data (query view, app format)
+   slub_q = slub_find.app_search("manfred bonitz")
+   # retrieve JSON data (detail view, app format)
+   slub_doc = slub_find.app_document("0-1132486122")

slubfind-0.1.0/slubfind.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+.gitignore
+CHANGELOG
+LICENSE
+README.rst
+pyproject.toml
+requirements.txt
+.github/workflows/pypi.yml
+.github/workflows/test.yml
+slubfind/__init__.py
+slubfind/_version.py
+slubfind/client.py
+slubfind/parser.py
+slubfind.egg-info/PKG-INFO
+slubfind.egg-info/SOURCES.txt
+slubfind.egg-info/dependency_links.txt
+slubfind.egg-info/requires.txt
+slubfind.egg-info/top_level.txt
+test/__init__.py
+test/test_client.py

slubfind-0.1.0/slubfind.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

slubfind-0.1.0/slubfind.egg-info/requires.txt

@@ -0,0 +1 @@
+txpyfind

slubfind-0.1.0/slubfind.egg-info/top_level.txt

@@ -0,0 +1 @@
+slubfind

slubfind-0.1.0/test/test_client.py

@@ -0,0 +1,43 @@
+from slubfind.client import SlubFind
+
+def test_get_document():
+    # create SlubFind instance
+    slub_find = SlubFind()
+    # retrieve JSON data (detail view, app format)
+    slub_app_doc = slub_find.app_document("0-1132486122")
+    assert slub_app_doc is not None
+
+def test_get_query():
+    # create SlubFind instance
+    slub_find = SlubFind()
+    # retrieve JSON data (query view, app format)
+    slub_app_query = slub_find.app_search("manfred bonitz")
+    assert slub_app_query is not None
+
+def test_settings():
+    # create SlubFind instance
+    slub_find = SlubFind()
+    # retrieve TYPO3-find settings (query view)
+    slub_find_settings = slub_find.settings()
+    assert slub_find_settings is not None
+
+#def test_solr_params():
+#    # create SlubFind instance
+#    slub_find = SlubFind()
+#    # retrieve Solr parameters (query view)
+#    slub_find_solr_params = slub_find.solr_params("manfred bonitz")
+#    assert slub_find_solr_params is not None
+
+#def test_solr_params_via_url():
+#    # create SlubFind instance
+#    slub_find = SlubFind()
+#    # retrieve Solr parameters (query view)
+#    slub_find_solr_params_via_url = slub_find.solr_params_via_url("https://katalog.slub-dresden.de/?tx_find_find%5Bq%5D%5Bdefault%5D=manfred+bonitz")
+#    assert slub_find_solr_params_via_url is not None
+
+def test_solr_request():
+    # create SlubFind instance
+    slub_find = SlubFind()
+    # retrieve Solr URL (query view)
+    slub_find_solr_request = slub_find.solr_request("manfred bonitz")
+    assert slub_find_solr_request is not None