qlever 0.3.8__py3-none-any.whl → 0.3.9__py3-none-any.whl

qlever/config.py

@@ -125,6 +125,7 @@ class QleverConfig:
                      f"want to use it, disable this warning as follows:"
                      f"\n\n"
                      f"export QLEVER_ARGCOMPLETE_CHECK_OFF")
+            log.info("")
 
         # Create a temporary parser only to parse the `--qleverfile` option, in
         # case it is given, and to determine whether a command was given that

{qlever-0.3.8.dist-info → qlever-0.3.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qlever
-Version: 0.3.8
+Version: 0.3.9
 Summary: Script for using the QLever SPARQL engine.
 Author-email: Hannah Bast <bast@cs.uni-freiburg.de>
 License: Apache License
@@ -215,13 +215,25 @@ License-File: LICENSE
 Requires-Dist: psutil
 Requires-Dist: termcolor
 
-# QLever Control
+# QLever
 
-This is a small repository, which provides a script `qlever` that can control
-everything that QLever does. The script is supposed to be very easy to use and
-pretty much self-explanatory as you use it. If you use Docker, you don't even
-have to download any QLever code (Docker will pull the required images) and the
-script is all you need.
+QLever is a very fast SPARQL engine, much faster than most existing engines. It
+can handle graphs with more than hundred billion triples on a single machine
+with moderate resources. See https://qlever.cs.uni-freiburg.de for more
+information and many public SPARQL endpoints that use QLever
+
+This project provides a Python script that can control everything that QLever
+does, in particular, creating SPARQL endpoints for arbitrary RDF datasets. It
+is supposed to be very easy to use and self-explanatory as you use it. In
+particular, the tool provides context-sensitive autocompletion of all its
+commands and options. If you use a container system (like Docker or Podman),
+you don't even have to download any QLever code, but the script will download
+the required image for you.
+
+NOTE: There has been a major update on 24.03.2024, which changed some of the
+Qleverfile variables and command-line options (all for the better, of course).
+If you encounter any problems, please contact us by opening an issue on
+https://github.com/ad-freiburg/qlever-control/issues.
 
 # Installation
 
@@ -231,17 +243,18 @@ that is not the case and tell you what to do.
 
 # Usage
 
-First, create an empty directory, with a name corresponding to the dataset you
-want to work with. For the following example, take `olympics`. Go to that
-directory, and do the following:
+Create an empty directory, with a name corresponding to the dataset you want to
+work with. For the following example, take `olympics`. Go to that directory
+and do the following. After the first call, `qlever` will tell you how to
+activate autocompletion for all its commands and options (it's very easy, but
+`pip` cannot do that automatically).
 
 ```
-qlever                         # Basic help + lists of available pre-configs
-qlever setup-config olympics   # Get examplary Qleverfile (config file)
-qlever get-data                # Download the dataset (see below)
+qlever setup-config olympics   # Get Qleverfile (config file) for this dataset
+qlever get-data                # Download the dataset
 qlever index                   # Build index data structures for this dataset
 qlever start                   # Start a QLever server using that index
-qlever test-query              # Launch a test query 
+qlever example-queries         # Launch some example queries
 qlever ui                      # Launch the QLever UI
 ```
 
@@ -254,25 +267,34 @@ seconds.
 Each command will also show you the command line it uses. That way you can
 learn, on the side, how QLever works internally. If you just want to know the
 command line for a particular command, without executing it, you can append
-"show" like this:
+`--show` like this:
 
 ```
-qlever index show
+qlever index --show
 ```
 
-There are many more commands and options, see `qlever --help`. The script
-supports autocompletion for all its commands and options. You can (and should)
-activate it following the instructions given when you just type `qlever`
-without any arguments.
+There are many more commands and options, see `qlever --help` for general help,
+`qlever <command> --help` for help on a specific command, or just the
+autocompletion.
 
 # For developers
 
 The (Python) code for the script is in the `*.py` files in `src/qlever`. The
 preconfigured Qleverfiles are in `src/qlever/Qleverfiles`.
 
-If you want to make changes to the script, git clone this repository, make any
-changes you want, and run `pip install -e .`. Then you can use the script (with
-whatever modifications you have made), just as if you had installed it via `pip
-install qlever`. Note that unless you change the directory structure, you have
-to execute `pip install -e .` only once (this local installation will not copy
-your files but link to them).
+If you want to make changes to the script, or add new commands, do as follows:
+
+```
+git clone https://github.com/ad-freiburg/qlever-control
+cd qlever-control
+pip install -e .
+```
+
+Then you can use `qlever` just as if you had installed it via `pip install
+qlever`. Note that you don't have to rerun `pip install -e .` when you modify
+any of the `*.py` files and not even when you add new commands in
+`src/qlever/commands`. The exceutable created by `pip` simply links and refers
+to the files in your working copy.
+
+If you have bug fixes or new useful features or commands, please open a pull
+request. If you have questions or suggestions, please open an issue.

{qlever-0.3.8.dist-info → qlever-0.3.9.dist-info}/RECORD

@@ -2,7 +2,7 @@ qlever/__init__.py,sha256=IyfS1OhlVE7-rjtv6FPlL0R56VxcNsS6KS7NJQhTDIM,1367
 qlever/__main__.py,sha256=MqM37bEzQeJEGUXZvuLcilIvnObZiG2eTGIkfKGpdnw,62016
 qlever/argcomplete-test.py,sha256=MJosqJc313c9aiPfuGJiaI2vwCf-dwAu-SVZ2TX5Wzk,463
 qlever/command.py,sha256=yOr0Uc8D8-AM7EjwDsVzbc3KNYjPH-FVOZhIHkqO588,2749
-qlever/config.py,sha256=BuAIWKq14KFHWBWrKz5OdD7OnvIvS9RHwboxV5l20mU,9992
+qlever/config.py,sha256=LOVW8alFCVgZz_GAWm7vnjZVMVE7m3QTecy34lHgjGE,10017
 qlever/containerize.py,sha256=p8g3O3G8a_0XLzSTzl_e5t9dqjbCQ-ippoA8vI2Z9pI,4193
 qlever/customhelp-test.py,sha256=fYLu-KMCHJQkQ8-XE6PtaYqPTMwI-Ew5B_EnIdHKxv4,1505
 qlever/log.py,sha256=k9Mq4hxQ_d2k0e-5ZVgcB2XIRhOsGMO9I3rIR7YQyDA,1376
@@ -42,9 +42,9 @@ qlever/commands/status.py,sha256=5S6EdapZEwFKV9cQZtNYcZhMbAXAY-FP6ggjIhfX8ek,163
 qlever/commands/stop.py,sha256=TZs4bxKHvujlZAU8BZmFjA5eXSZNAa6EeNzvPpEZsuI,4139
 qlever/commands/ui.py,sha256=rV8u017WLbfz0zVT_c9GC4d9v1WWwrTM3kfGONbeCvQ,2499
 qlever/commands/warmup.py,sha256=WOZSxeV8U_F6pEEnAb6YybXLQMxZFTRJXs4BPHUhsmc,1030
-qlever-0.3.8.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-qlever-0.3.8.dist-info/METADATA,sha256=y6kTTCztfGGJDnQvAk1rWFNeCBTOUEEhRrQpnJjiC9Y,16097
-qlever-0.3.8.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-qlever-0.3.8.dist-info/entry_points.txt,sha256=s0iWBHKRUzsJ7B6nVGiyMdOJtiOS84IJMSSxgbNU6LU,85
-qlever-0.3.8.dist-info/top_level.txt,sha256=kd3zsYqiFd0--Czh5XTVkfEq6XR-XgRFW35X0v0GT-c,7
-qlever-0.3.8.dist-info/RECORD,,
+qlever-0.3.9.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+qlever-0.3.9.dist-info/METADATA,sha256=xSj11QMM7EztxVfk0Yi1N7F65h2XKfNsghyWxF96wg8,17049
+qlever-0.3.9.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+qlever-0.3.9.dist-info/entry_points.txt,sha256=s0iWBHKRUzsJ7B6nVGiyMdOJtiOS84IJMSSxgbNU6LU,85
+qlever-0.3.9.dist-info/top_level.txt,sha256=kd3zsYqiFd0--Czh5XTVkfEq6XR-XgRFW35X0v0GT-c,7
+qlever-0.3.9.dist-info/RECORD,,