Merge pull request #302 from CLARIAH/dev

Merging dev updates for release 1.3.4

Author: c-martinez

.github/workflows/tweet-release.yml

@@ -0,0 +1,23 @@
+name: Tweet release
+# Tweets will happen when a new release is published
+on:
+  release:
+    types:
+      - published
+jobs:
+  tweet:
+    runs-on: ubuntu-latest
+    steps:
+    - name: GitHub Twittction
+      uses: m1ner79/Github-Twittction@v1.0.1
+      with:
+        # Message posted on twitter
+        twitter_status: "Release ${{github.event.release.tag_name}} of ${{github.event.repository.full_name}} is out! Check out the release notes ${{github.event.release.html_url}}"
+        # Twitter Consumer Key is referenced here
+        twitter_consumer_key: ${{ secrets.TWITTER_CONSUMER_KEY }}
+        # Twitter Consumer Secret is referenced here
+        twitter_consumer_secret: ${{ secrets.TWITTER_CONSUMER_SECRET }}
+        # Twitter Access Token Key is referenced here
+        twitter_access_token_key: ${{ secrets.TWITTER_ACCESS_TOKEN_KEY }}
+        # Twitter Access Token Secret is referenced here
+        twitter_access_token_secret: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}

.zenodo.json

@@ -0,0 +1,35 @@
+{
+    "creators": [
+        {
+            "affiliation": "Vrije Universiteit Amsterdam",
+            "name": "Meroño-Peñuela, Albert"
+        },
+        {
+            "name": "Hoekstra, Rinke"
+        },
+        {
+            "affiliation": "Netherlands eScience Center",
+            "name": "Martinez, Carlos",
+            "orcid": "0000-0001-5565-7577"
+        },
+        {
+            "affiliation": "International Institute of Social History",
+            "name": "Zijdeman, Richard"
+        }
+    ],
+    "description": "grlc, the git repository linked data API constructor, automatically builds Web APIs using SPARQL queries stored in git repositories.",
+    "doi": "10.5281/zenodo.1064392",
+    "keywords": [
+        "swagger-ui",
+        "sparql",
+        "linked-data",
+        "semantic-web",
+        "linked-data-api"
+    ],
+    "license": {
+        "id": "MIT"
+    },
+    "publication_date": "2017-11-22",
+    "title": "grlc",
+    "version": "1.3.4"
+}

CITATION.cff

@@ -25,4 +25,11 @@ license: MIT
 message: "If you use this software, please cite it as below."
 repository-code: "https://github.com/CLARIAH/grlc"
 title: grlc
+abstract: grlc, the git repository linked data API constructor, automatically builds Web APIs using SPARQL queries stored in git repositories.
+keywords: 
+  - "swagger-ui"
+  - sparql
+  - "linked-data"
+  - "semantic-web"
+  - "linked-data-api"
 version: "1.3.4"

MANIFEST.in

@@ -1,2 +1,3 @@
 include requirements.txt
 include requirements-test.txt
+include CITATION.cff

README.md

@@ -29,7 +29,11 @@ grlc is a lightweight server that takes SPARQL queries (stored in a GitHub repos
 For a quick usage tutorial check out our wiki [walkthrough](https://github.com/CLARIAH/grlc/wiki/Quick-tutorial) and [list of features](https://github.com/CLARIAH/grlc/wiki/Features).
 
 ## Usage
-grlc assumes that you have a collection of SPARQL queries as .rq files (like [this](https://github.com/CEDAR-project/Queries)). grlc will create an API operation per such a SPARQL query/.rq file. Your queries can include special [decorators](#decorator-syntax) to add extra functionality to your API.
+grlc assumes that you have a collection of SPARQL queries as .rq files (like [this](https://github.com/CLARIAH/grlc-queries)). grlc will create one API operation for each SPARQL query/.rq file in the collection.
+
+Your queries can add API parameters to each operation by using the [parameter mapping](https://github.com/CLARIAH/grlc/wiki/Parameter-Mapping) syntax. This allows your query to define query variables which will be mapped to API parameters for your API operation ([see here](https://github.com/CLARIAH/grlc-queries/blob/master/enumerate.rq) for an example).
+
+Your queries can include special [decorators](#decorator-syntax) to add extra functionality to your API.
 
 ### Query location
 grlc can load your query collection from different locations: from a GitHub repository (`api-git`), from local storage (`api-local`), and from a specification file (`api-url`). Each type of location has specific features and is accessible via different paths. However all location types produce the same beautiful APIs.
@@ -51,7 +55,17 @@ grlc can also use a subdirectory inside your Github repo. This can be done by in
 > API path:
 `http://grlc-server/api-local/`
 
-grlc can generate an API from a local directory in the computer where your grlc server runs. You can configure the location of this folder in your [grlc server configuration file](#grlc-server-configuration). See also [how to install and run your own grlc instance](#install-and-run).
+grlc can generate an API from a local directory in the computer where your grlc server runs. You can configure the location of this directory in your [grlc server configuration file](#grlc-server-configuration). See also [how to install and run your own grlc instance](#install-and-run).
+
+When the API is generated from a local directory, API information can be loaded from a configuration file in that folder. This file must be called `local-api-config.ini` and it has the following format:
+```ini
+[repo_info]
+repo_title = Some title
+api_description = Description of my API
+contact_name = My name
+contact_url = https://mypage/
+licence_url = https://mylicence/
+```
 
 #### From a specification file
 > API path:
@@ -66,13 +80,15 @@ For example, assuming your queries are listed on spec file: `https://raw.githubu
 A grlc API specification file is a YAML file which includes the necessary information to create a grlc API, most importantly a list of URLs to decorated and HTTP-dereferenceable SPARQL queries. This file should contain the following fields
 
  - `title`: Title of my API
+ - `description`: API description
  - `contact`: Contact details of the API owner. This should include the `name` and `url` properties.
  - `licence`: A URL pointing to the licence file for the API.
  - `queries`: A list of URLs of SPARQL queries (with header decorators).
 
 For example:
 ```YAML
 title: Title of my API
+description: Description of my API
 contact:
   name: Contact Name
   url: https://www.mywebsite.org
@@ -223,6 +239,7 @@ Check these out:
 - http://grlc.io/api-git/CLARIAH/wp4-queries-hisco
 - http://grlc.io/api-git/albertmeronyo/lodapi
 - http://grlc.io/api-git/albertmeronyo/lsq-api
+- https://grlc.io/api-git/CEDAR-project/Queries
 
 You'll find the sources of these and many more in [GitHub](https://github.com/search?o=desc&q=endpoint+summary+language%3ASPARQL&s=indexed&type=Code&utf8=%E2%9C%93)
 

bin/grlc-server

@@ -39,7 +39,8 @@ def runViaGunicorn(port=8088):
     options = {
         'bind': '%s:%d' % ('0.0.0.0', port),
         'workers': 20,
-        'debug': static.LOG_DEBUG_MODE
+        'debug': static.LOG_DEBUG_MODE,
+        'timeout': 90
     }
     StandaloneApplication(grlc_app, options).run()