snapquery 0.0.1__tar.gz

snapquery-0.0.1/.github/workflows/build.yml

@@ -0,0 +1,41 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Build
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  GHACTIONS: ACTIVE
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.9, '3.10','3.11','3.12']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+
+    - name: install
+      run: |
+        scripts/install
+
+    - name: Run tests
+      run: |
+        scripts/test

snapquery-0.0.1/.github/workflows/upload-to-pypi.yml

@@ -0,0 +1,27 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+    - name: Build and publish
+      run: |
+        hatch build
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

snapquery-0.0.1/.gitignore

@@ -0,0 +1,160 @@
+# 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/
+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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

snapquery-0.0.1/.project

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>snapquery</name>
+	<comment></comment>
+	<projects>
+		<project>nicegui</project>
+		<project>nicegui_widgets</project>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.python.pydev.PyDevBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.python.pydev.pythonNature</nature>
+	</natures>
+</projectDescription>

snapquery-0.0.1/.pydevproject

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<?eclipse-pydev version="1.0"?><pydev_project>
+    <pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Default</pydev_property>
+    <pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python interpreter</pydev_property>
+    <pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
+        <path>/${PROJECT_DIR_NAME}</path>
+    </pydev_pathproperty>
+</pydev_project>

snapquery-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

snapquery-0.0.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.3
+Name: snapquery
+Version: 0.0.1
+Summary: snapquery: Introduce Named Queries and Named Query Middleware to wikidata
+Project-URL: Home, https://github.com/WolfgangFahl/snapquery
+Project-URL: Documentation, https://wiki.bitplan.com/index.php/snapquery
+Project-URL: Source, https://github.com/WolfgangFahl/snapquery
+Author-email: Wolfgang Fahl <wf@WolfgangFahl.com>
+Maintainer-email: Wolfgang Fahl <wf@WolfgangFahl.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: SPARQL,blazegraph,middleware,nicegui,qlever,query,wikidata
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.9
+Requires-Dist: ngwidgets>=0.14.2
+Requires-Dist: pylodstorage>=0.10.3
+Provides-Extra: test
+Requires-Dist: green; extra == 'test'
+Description-Content-Type: text/markdown
+
+# snapQuery
+Tool that helps users preview, annotate, rate, comment, run and explore Wikidata queries on different sparql backends seamlessly. 
+It enhances the user experience by storing the results and comparing the results from different backends and comparing over time. 
+
+The purpose of the tool is to help users curate and collaborate on queries together and make sure they work as expected over time. 
+Developers and data consumers can get access to the data via APIs.
+
+[![Join the discussion at https://github.com/WolfgangFahl/snapquery/discussions](https://img.shields.io/github/discussions/WolfgangFahl/snapquery)](https://github.com/WolfgangFahl/snapquery/discussions)
+[![pypi](https://img.shields.io/pypi/pyversions/snapquery)](https://pypi.org/project/snapquery/)
+[![Github Actions Build](https://github.com/WolfgangFahl/snapquery/actions/workflows/build.yml/badge.svg)](https://github.com/WolfgangFahl/snapquery/actions/workflows/build.yml)
+[![PyPI Status](https://img.shields.io/pypi/v/snapquery.svg)](https://pypi.python.org/pypi/snapquery/)
+[![GitHub issues](https://img.shields.io/github/issues/WolfgangFahl/snapquery.svg)](https://github.com/WolfgangFahl/snapquery/issues)
+[![GitHub issues](https://img.shields.io/github/issues-closed/WolfgangFahl/snapquery.svg)](https://github.com/WolfgangFahl/snapquery/issues/?q=is%3Aissue+is%3Aclosed)
+[![GitHub](https://img.shields.io/github/license/WolfgangFahl/snapquery)](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Demos
+* [BITPlan](https://snapquery.bitplan.com)
+* [RWTH Aachen i5](https://snapquery.wikidata.dbis.rwth-aachen.de/)
+
+
+
+# Features
+## Planned
+These are the planned features
+* query multiple backends simultaneously and repeatedly
+* stores queries and adaptations needed for different backends
+* support user login
+* support for spam protection
+* support for naming queries
+* support for rating queries
+* support for sharing queries (unique identifier)
+* support for commenting on queries
+* support for detecting when a query returns different results between different backends
+* support for query states: reliable, needs investigation, need verification
+* support for autodetecting when a query returns fewer results than before (change in underlying data/model in Wikidata) -> needs investigation
+* support for marking queries as reliable query by users
+* support for seeing a state history per query
+* support for storing query results so you don’t have to wait
+* support for adding metadata to queries
+  * add main subject (QID) to query
+  * author -> id of author in the system
+  * forked from x
+* has REST API for data consumers e.g. LLM developers who want to present user-verified queries and data to users to increase reliability
+
+## User stories
+* as a user I want to know in advance if the query is returning what I expect
+* as a user I want to find all the bands in Wikidata without having to know how it is modeled
+* as a user I want pay someone to help me get the information from Wikidata that I need
+* as a user I want to know how a query performed in the past so I can trust that the underlying model is stable and I get the expected results
+* as a user I want to comment on a query
+* as a user I want to read comments from others on a query so I get and idea how reliable it is
+* as a user I want to rate a query with 1-5 stars
+* as a user I want to get information from multiple sparql engines at the same time
+* as a user I don’t want to wait for a fresh query to finish and just get the information from the latest time a query succeeded.
+* as a user I want a list of queries in the middleware
+* as a user I want to sort the list based on the rate of queries
+* as a user I want to annotate a query with a name
+* as a user I want to annotate a query with a wikidata item as main subject
+* as a user I want to see a list of queries that is tagged with a certain topic (wikidata item)
+* as a user I want an API to get information from the middleware about queries
+* as a user I want an api endpoint /list that gives me all queries with the main subject=Qxxxx
+* as a user I want the system to warn me and annotate a query that no longer returns the data the user expects, ie. if a query suddenly start returning no results or fewer results
+* as a user I want to see a state on a query
+* as a user I want to log in using github to avoid the hassle of creating another account
+* as a user I want to log in using gitlab to avoid the hassle of creating another account
+* as a user I want to log in using facebook to avoid the hassle of creating another account
+* as a user I want to know how many backends a query is working on, so I get an overview
+* as a user I want to get query results immediately if possible so I don’t have to wait
+* as a user I want to import a query by copy pasting a url from WDQS
+* as a user I want to run a query on multiple backends with one click
+* as a user I want to fork a query and build on it
+* as a wikidata contributor I want to be able to override the “bad query” state
+* as a wikidata user I want to be able to log in using my wmf credentials to avoid the hassle of creating another account
+* as a wikidata user I want to link my current account to my wmf account so others can find me by username
+* as a developer I want to expose the data in API endpoints
+* as a LLM developer I want to consume the queries and use them to improve my LLM so it can suggest KNOWN GOOD queries to users

snapquery-0.0.1/README.md

@@ -0,0 +1,76 @@
+# snapQuery
+Tool that helps users preview, annotate, rate, comment, run and explore Wikidata queries on different sparql backends seamlessly. 
+It enhances the user experience by storing the results and comparing the results from different backends and comparing over time. 
+
+The purpose of the tool is to help users curate and collaborate on queries together and make sure they work as expected over time. 
+Developers and data consumers can get access to the data via APIs.
+
+[![Join the discussion at https://github.com/WolfgangFahl/snapquery/discussions](https://img.shields.io/github/discussions/WolfgangFahl/snapquery)](https://github.com/WolfgangFahl/snapquery/discussions)
+[![pypi](https://img.shields.io/pypi/pyversions/snapquery)](https://pypi.org/project/snapquery/)
+[![Github Actions Build](https://github.com/WolfgangFahl/snapquery/actions/workflows/build.yml/badge.svg)](https://github.com/WolfgangFahl/snapquery/actions/workflows/build.yml)
+[![PyPI Status](https://img.shields.io/pypi/v/snapquery.svg)](https://pypi.python.org/pypi/snapquery/)
+[![GitHub issues](https://img.shields.io/github/issues/WolfgangFahl/snapquery.svg)](https://github.com/WolfgangFahl/snapquery/issues)
+[![GitHub issues](https://img.shields.io/github/issues-closed/WolfgangFahl/snapquery.svg)](https://github.com/WolfgangFahl/snapquery/issues/?q=is%3Aissue+is%3Aclosed)
+[![GitHub](https://img.shields.io/github/license/WolfgangFahl/snapquery)](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Demos
+* [BITPlan](https://snapquery.bitplan.com)
+* [RWTH Aachen i5](https://snapquery.wikidata.dbis.rwth-aachen.de/)
+
+
+
+# Features
+## Planned
+These are the planned features
+* query multiple backends simultaneously and repeatedly
+* stores queries and adaptations needed for different backends
+* support user login
+* support for spam protection
+* support for naming queries
+* support for rating queries
+* support for sharing queries (unique identifier)
+* support for commenting on queries
+* support for detecting when a query returns different results between different backends
+* support for query states: reliable, needs investigation, need verification
+* support for autodetecting when a query returns fewer results than before (change in underlying data/model in Wikidata) -> needs investigation
+* support for marking queries as reliable query by users
+* support for seeing a state history per query
+* support for storing query results so you don’t have to wait
+* support for adding metadata to queries
+  * add main subject (QID) to query
+  * author -> id of author in the system
+  * forked from x
+* has REST API for data consumers e.g. LLM developers who want to present user-verified queries and data to users to increase reliability
+
+## User stories
+* as a user I want to know in advance if the query is returning what I expect
+* as a user I want to find all the bands in Wikidata without having to know how it is modeled
+* as a user I want pay someone to help me get the information from Wikidata that I need
+* as a user I want to know how a query performed in the past so I can trust that the underlying model is stable and I get the expected results
+* as a user I want to comment on a query
+* as a user I want to read comments from others on a query so I get and idea how reliable it is
+* as a user I want to rate a query with 1-5 stars
+* as a user I want to get information from multiple sparql engines at the same time
+* as a user I don’t want to wait for a fresh query to finish and just get the information from the latest time a query succeeded.
+* as a user I want a list of queries in the middleware
+* as a user I want to sort the list based on the rate of queries
+* as a user I want to annotate a query with a name
+* as a user I want to annotate a query with a wikidata item as main subject
+* as a user I want to see a list of queries that is tagged with a certain topic (wikidata item)
+* as a user I want an API to get information from the middleware about queries
+* as a user I want an api endpoint /list that gives me all queries with the main subject=Qxxxx
+* as a user I want the system to warn me and annotate a query that no longer returns the data the user expects, ie. if a query suddenly start returning no results or fewer results
+* as a user I want to see a state on a query
+* as a user I want to log in using github to avoid the hassle of creating another account
+* as a user I want to log in using gitlab to avoid the hassle of creating another account
+* as a user I want to log in using facebook to avoid the hassle of creating another account
+* as a user I want to know how many backends a query is working on, so I get an overview
+* as a user I want to get query results immediately if possible so I don’t have to wait
+* as a user I want to import a query by copy pasting a url from WDQS
+* as a user I want to run a query on multiple backends with one click
+* as a user I want to fork a query and build on it
+* as a wikidata contributor I want to be able to override the “bad query” state
+* as a wikidata user I want to be able to log in using my wmf credentials to avoid the hassle of creating another account
+* as a wikidata user I want to link my current account to my wmf account so others can find me by username
+* as a developer I want to expose the data in API endpoints
+* as a LLM developer I want to consume the queries and use them to improve my LLM so it can suggest KNOWN GOOD queries to users

snapquery-0.0.1/pyproject.toml

@@ -0,0 +1,63 @@
+# see https://flit.pypa.io/en/latest/pyproject_toml.html
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "snapquery"
+description = "snapquery: Introduce Named Queries and Named Query Middleware to wikidata"
+keywords = [ "nicegui", "wikidata","SPARQL","query","middleware","qlever","blazegraph"]
+home-page = "https://github.com/WolfgangFahl/snapquery"
+authors = [
+  {name = "Wolfgang Fahl", email = "wf@WolfgangFahl.com"}
+]
+maintainers = [
+  { name = "Wolfgang Fahl", email = "wf@WolfgangFahl.com" },
+]
+readme = "README.md"
+license = {text = "Apache-2.0"}
+dependencies = [
+	# https://github.com/WolfgangFahl/nicegui_widgets
+	"ngwidgets>=0.14.2",
+  # https://pypi.org/project/pyLodStorage/
+  "pyLodStorage>=0.10.3"
+]
+
+requires-python = ">=3.9"
+classifiers=[
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: User Interfaces",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: Apache Software License"
+    ]
+dynamic = ["version"]
+[tool.hatch.version]
+path = "snapquery/__init__.py"
+
+[project.urls]
+Home = "https://github.com/WolfgangFahl/snapquery"
+Documentation = "https://wiki.bitplan.com/index.php/snapquery"
+Source = "https://github.com/WolfgangFahl/snapquery"
+
+[project.optional-dependencies]
+test = [
+  "green",
+]
+
+[tool.hatch.build.targets.wheel]
+only-include = ["snapquery"]
+
+[tool.hatch.build.targets.wheel.sources]
+"snapquery" = "snapquery"
+
+[project.scripts]
+snapquery = "snapquery.snapquery_cmd:main"

snapquery-0.0.1/scripts/blackisort

@@ -0,0 +1,7 @@
+#!/bin/bash
+# WF 2024-05-03
+package=snapquery
+isort tests/*.py
+black tests/*.py
+isort $package/*.py
+black $package/*.py

snapquery-0.0.1/scripts/install

@@ -0,0 +1,3 @@
+#!/bin/bash
+# WF 2023-11-06
+pip install .

snapquery-0.0.1/scripts/test

@@ -0,0 +1,9 @@
+#!/bin/bash
+# WF 2023-11-06
+#python3 -m unittest discover
+pip list | egrep "^green " 
+if [ $? -ne 0 ]
+then
+  pip install green
+fi
+green tests -s 1

snapquery-0.0.1/snapquery/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

snapquery-0.0.1/snapquery/snapquery_cmd.py

@@ -0,0 +1,43 @@
+"""
+Created on 2024-05-03
+
+@author: wf
+"""
+import sys
+from argparse import ArgumentParser
+
+from ngwidgets.cmd import WebserverCmd
+
+from snapquery.snapquery_webserver import SnapQueryWebServer
+
+
+class SnapQueryCmd(WebserverCmd):
+    """
+    Command line for diagrams server
+    """
+
+    def getArgParser(self, description: str, version_msg) -> ArgumentParser:
+        """
+        override the default argparser call
+        """
+        parser = super().getArgParser(description, version_msg)
+        return parser
+
+
+def main(argv: list = None):
+    """
+    main call
+    """
+    cmd = SnapQueryCmd(
+        config=SnapQueryWebServer.get_config(),
+        webserver_cls=SnapQueryWebServer,
+    )
+    exit_code = cmd.cmd_main(argv)
+    return exit_code
+
+
+DEBUG = 0
+if __name__ == "__main__":
+    if DEBUG:
+        sys.argv.append("-d")
+    sys.exit(main())

snapquery-0.0.1/snapquery/snapquery_core.py

@@ -0,0 +1,5 @@
+"""
+Created on 2024-05-03
+
+@author: wf
+"""

snapquery-0.0.1/snapquery/snapquery_webserver.py

@@ -0,0 +1,51 @@
+"""
+Created on 2024-05-03
+@author: wf
+"""
+from ngwidgets.input_webserver import InputWebserver, InputWebSolution, WebserverConfig
+from nicegui.client import Client
+
+from snapquery.version import Version
+
+
+class SnapQueryWebServer(InputWebserver):
+    """
+    server to supply named Queries
+    """
+
+    @classmethod
+    def get_config(cls) -> WebserverConfig:
+        """
+        get the configuration for this Webserver
+        """
+        copy_right = ""
+        config = WebserverConfig(
+            short_name="snapquery",
+            copy_right=copy_right,
+            version=Version(),
+            default_port=9862,
+        )
+        server_config = WebserverConfig.get(config)
+        server_config.solution_class = SnapQuerySolution
+        return server_config
+
+    def __init__(self):
+        """Constructs all the necessary attributes for the WebServer object."""
+        InputWebserver.__init__(self, config=SnapQueryWebServer.get_config())
+
+
+class SnapQuerySolution(InputWebSolution):
+    """
+    the Snap Query solution
+    """
+
+    def __init__(self, webserver: SnapQueryWebServer, client: Client):
+        """
+        Initialize the solution
+
+        Calls the constructor of the base solution
+        Args:
+            webserver (SnapQueryWebServer): The webserver instance associated with this context.
+            client (Client): The client instance this context is associated with.
+        """
+        super().__init__(webserver, client)  # Call to the superclass constructor

snapquery-0.0.1/snapquery/version.py

@@ -0,0 +1,40 @@
+"""
+Created on 2024-05-01
+
+@author: wf
+"""
+from dataclasses import dataclass
+
+import snapquery
+
+
+@dataclass
+class Version:
+    """
+    Version handling for nicepdf
+    """
+
+    name = "snapquery"
+    version = snapquery.__version__
+    date = "2024-05-03"
+    updated = "2024-05-03"
+    description = "Introduce Named Queries and Named Query Middleware to wikidata"
+
+    authors = "Wolfgang Fahl"
+
+    doc_url = "https://wiki.bitplan.com/index.php/snapquery"
+    chat_url = "https://github.com/WolfgangFahl/snapquery/discussions"
+    cm_url = "https://github.com/WolfgangFahl/snapquery"
+
+    license = f"""Copyright 2024 contributors. All rights reserved.
+
+  Licensed under the Apache License 2.0
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Distributed on an "AS IS" basis without warranties
+  or conditions of any kind, either express or implied."""
+
+    longDescription = f"""{name} version {version}
+{description}
+
+  Created by {authors} on {date} last updated {updated}"""

snapquery-0.0.1/tests/test_endpoints.py

@@ -0,0 +1,24 @@
+'''
+Created on 2024-05-03
+
+@author: wf
+'''
+from ngwidgets.basetest import Basetest
+from lodstorage.query import EndpointManager
+
+class TestEndpoints(Basetest):
+    """
+    test endpoint handling according to https://github.com/WolfgangFahl/snapquery/issues/1
+    """
+    
+    def setUp(self, debug=False, profile=True):
+        Basetest.setUp(self, debug=debug, profile=profile)
+        
+    def testEndpoints(self):
+        """
+        test the endpoint handling
+        """
+        em=EndpointManager()
+        ep_names=em.getEndpointNames()
+        self.assertTrue("wikidata" in ep_names)
+        pass