Difference between revisions of "Snapquery"
Jump to navigation
Jump to search
| Line 13: | Line 13: | ||
}} | }} | ||
| + | = Usage = | ||
| + | == Commandline == | ||
| + | === Help === | ||
| + | <source lang='bash'> | ||
| + | snapquery -h | ||
| + | usage: snapquery [-h] [-a] [--apache APACHE] [-c] [-d] | ||
| + | [--debugServer DEBUGSERVER] [--debugPort DEBUGPORT] | ||
| + | [--debugRemotePath DEBUGREMOTEPATH] | ||
| + | [--debugLocalPath DEBUGLOCALPATH] [-l] [-i INPUT] [-rol] | ||
| + | [--host HOST] [--port PORT] [-s] [-V] [-ep ENDPOINTPATH] | ||
| + | [-en ENDPOINTNAME] [-le] | ||
| + | |||
| + | Introduce Named Queries and Named Query Middleware to wikidata | ||
| + | |||
| + | options: | ||
| + | -h, --help show this help message and exit | ||
| + | -a, --about show about info [default: False] | ||
| + | --apache APACHE create an apache configuration file for the given | ||
| + | domain | ||
| + | -c, --client start client [default: False] | ||
| + | -d, --debug show debug info [default: False] | ||
| + | --debugServer DEBUGSERVER | ||
| + | remote debug Server | ||
| + | --debugPort DEBUGPORT | ||
| + | remote debug Port | ||
| + | --debugRemotePath DEBUGREMOTEPATH | ||
| + | remote debug Server path mapping - remotePath - path | ||
| + | on debug server | ||
| + | --debugLocalPath DEBUGLOCALPATH | ||
| + | remote debug Server path mapping - localPath - path on | ||
| + | machine where python runs | ||
| + | -l, --local run with local file system access [default: False] | ||
| + | -i INPUT, --input INPUT | ||
| + | input file | ||
| + | -rol, --render_on_load | ||
| + | render on load [default: False] | ||
| + | --host HOST the host to serve / listen from [default: localhost] | ||
| + | --port PORT the port to serve from [default: 9862] | ||
| + | -s, --serve start webserver [default: False] | ||
| + | -V, --version show program's version number and exit | ||
| + | -ep ENDPOINTPATH, --endpointPath ENDPOINTPATH | ||
| + | path to yaml file to configure endpoints to use for | ||
| + | queries | ||
| + | -en ENDPOINTNAME, --endpointName ENDPOINTNAME | ||
| + | Name of the endpoint to use for queries - use | ||
| + | --listEndpoints to list available endpoints | ||
| + | -le, --listEndpoints show the list of available endpoints | ||
| + | </source> | ||
{{pip|snapquery}} | {{pip|snapquery}} | ||
Revision as of 06:13, 4 May 2024
OsProject
| OsProject | |
|---|---|
| id | snapquery |
| state | active |
| owner | WolfgangFahl |
| title | snapquery |
| url | https://github.com/WolfgangFahl/snapquery |
| version | 0.0.1 |
| description | Frontend to Introduce Named Queries and Named Query Middleware to wikidata |
| date | 2024-05-03 |
| since | 2024-05-03 |
| until | |
Usage
Commandline
Help
snapquery -h
usage: snapquery [-h] [-a] [--apache APACHE] [-c] [-d]
[--debugServer DEBUGSERVER] [--debugPort DEBUGPORT]
[--debugRemotePath DEBUGREMOTEPATH]
[--debugLocalPath DEBUGLOCALPATH] [-l] [-i INPUT] [-rol]
[--host HOST] [--port PORT] [-s] [-V] [-ep ENDPOINTPATH]
[-en ENDPOINTNAME] [-le]
Introduce Named Queries and Named Query Middleware to wikidata
options:
-h, --help show this help message and exit
-a, --about show about info [default: False]
--apache APACHE create an apache configuration file for the given
domain
-c, --client start client [default: False]
-d, --debug show debug info [default: False]
--debugServer DEBUGSERVER
remote debug Server
--debugPort DEBUGPORT
remote debug Port
--debugRemotePath DEBUGREMOTEPATH
remote debug Server path mapping - remotePath - path
on debug server
--debugLocalPath DEBUGLOCALPATH
remote debug Server path mapping - localPath - path on
machine where python runs
-l, --local run with local file system access [default: False]
-i INPUT, --input INPUT
input file
-rol, --render_on_load
render on load [default: False]
--host HOST the host to serve / listen from [default: localhost]
--port PORT the port to serve from [default: 9862]
-s, --serve start webserver [default: False]
-V, --version show program's version number and exit
-ep ENDPOINTPATH, --endpointPath ENDPOINTPATH
path to yaml file to configure endpoints to use for
queries
-en ENDPOINTNAME, --endpointName ENDPOINTNAME
Name of the endpoint to use for queries - use
--listEndpoints to list available endpoints
-le, --listEndpoints show the list of available endpoints
Installation
pip install snapquery
# alternatively if your pip is not a python3 pip
pip3 install snapquery
# local install from source directory of snapquery
pip install .
upgrade
pip install snapquery -U
# alternatively if your pip is not a python3 pip
pip3 install snapquery -U