fcs-ql-parser 1.0.0

"FCS-QL (CLARIN-FCS Core 2.0 Query Language) Grammar and Parser"

FCS-QL for Python

• CLARIN-FCS Core 2.0 query language grammar and parser
• based on Github: clarin-eric/fcs-ql and Github: clarin-eric/fcs-simple-endpoint
• for more details visit: CLARIN FCS Technical Details

Installation

# built package
python3 -m pip install dist/fcs_ql_parser-<version>-py2.py3-none-any.whl
# or
python3 -m pip install dist/fcs-ql-parser-<version>.tar.gz

# for local development
python3 -m pip install -e .

Building

Fetch (or update) grammar files:

git clone https://github.com/clarin-eric/fcs-ql.git
cp fcs-ql/src/main/antlr4/eu/clarin/sru/fcs/qlparser/*.g4 src/fcsql/

(Re-)Generate python parser code:

# create virtual env
python3 -m venv venv
source venv/bin/activate
pip install -U pip setuptools wheel

# install antler tool
python3 -m pip install antlr4-tools
# pip install -e .[antlr]

cd src/fcsql
antlr4 -Dlanguage=Python3 *.g4

Build package:

# pip install -e .[build]
python3 -m build

Development

• Uses pytest (with coverage, clarity and randomly plugins).

python3 -m pip install -e .[test]

pytest

Run style checks:

# general style checks
python3 -m pip install -e .[style]

black --check .
flake8 . --show-source --statistics
isort --check --diff .
mypy src

# building the package and check metadata
python3 -m pip install -e .[build]

python3 -m build
twine check --strict dist/*

# build documentation and check links ...
python3 -m pip install -e .[docs]

sphinx-build -b html docs dist/docs
sphinx-build -b linkcheck docs dist/docs

Build documentation

python3 -m pip install -r ./docs/requirements.txt
# or 
python3 -m pip install -e .[docs]

sphinx-build -b html docs dist/docs
sphinx-build -b linkcheck docs dist/docs

See also

• clarin-eric/fcq-ql
• clarin-eric/fcs-simple-endpoint
• Specification on CLARIN FCS 2.0