lcpcli 0.1.1

Helper for converting CONLLU files and uploading the corpus to LCP

LCP CLI module

Helper for converting CONLLU files and uploading the corpus to LCP

Installation

Clone this project along with its submodules:

git clone --recurse-submodules [e-mail]:LiRI/projects/lcpcli.git

Make sure you have python 3.11 and pip installed in your local environment, then run:

./install.sh

Usage

Help:

lcpcli --help

CoNLL-U Format

The CoNLL-U format is documented at: https://universaldependencies.org/format.html

The LCP CLI converter will treat all the comments that start with text as document-level attributes. This means that if a CoNLL-U file contains the line # text_author = John Doe, then in LCP all the sentences from this file will be associated with a document whose meta attribute will contain text_author: 'John Doe'

All other comment lines following the format # key = value will add an entry to the meta attribute of the segment corresponding to the sentence below that line (ie not at the document level)

See below how to report these attributes in the template .json file

Convert and Upload

1. Create a parent directory in which you have a child directory that contains all your properly-fromatted CONLLU files

2. In the parent directory, next to the folder containing the CONLLU files, create a template .json file that describes your corpus structure (see above about the attributes key on Document and Segment), for example:

{
    "meta":{
        "name":"My corpus",
        "author":"Myself",
        "date":"2023",
        "version": 1,
        "corpusDescription":"This is my corpus"
    },
    "firstClass": {
        "document": "Document",
        "segment": "Segment",
        "token": "Token"
    },
    "layer": {
        "Token": {
            "abstract": false,
            "layerType": "unit",
            "anchoring": {
                "location": false,
                "stream": true,
                "time": false
            },
            "attributes": {
                "form": {
                    "isGlobal": false,
                    "type": "text",
                    "nullable": false
                },
                "lemma": {
                    "isGlobal": false,
                    "type": "text",
                    "nullable": true
                },
                "upos": {
                    "isGlobal": true,
                    "type": "categorical",
                    "nullable": false
                }
            }
        },
        "Segment": {
            "abstract": false,
            "layerType": "span",
            "contains": "Token",
            "attributes": {
                "meta": {
                    "key": {
                      "type": "text",
                      "nullable": true
                    }
                }
            }
        },
        "Document": {
            "abstract": false,
            "contains": "Segment",
            "layerType": "span",
            "attributes": {
                "meta": {
                    "text_author": {
                      "type": "text",
                      "nullable": true
                    }
                }
            }
        }
    }
}

3. Visit LCP and create a new project if you don't already have one where your corpus should go

4. Retrieve the API key and secret for your project by clicking on the button that says: "Create API Key"

   The secret will appear at the bottom of the page and remain visible only for 120s, after which it will disappear forever (you would then need to revoke the API key and create a new one)

   The key itself is listed above the button that says "Revoke API key" (make sure to not copy the line that starts with "Secret Key" along with the API key itself)

5. Once you have your API key and secret, you can start converting and uploading your corpus by running the following command:

lcpcli -i $CONLLU_FOLDER -m upload -k $API_KEY -s $API_SECRET -p $PROJECT_NAME --live

• $CONLLU_FOLDER should point to the folder that contains your CONLLU files (ie. inside the parent folder)
• $API_KEY is the key you copied from your project on LCP (still visible when you visit the page)
• $API_SECRET is the secret you copied from your project on LCP (only visible upon API Key creation)
• $PROJECT_NAME is the name of the project exactly as displayed on LCP -- it is case-sensitive, and space characters should be escaped