lcpcli 0.1.1__tar.gz

lcpcli-0.1.1/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2023 Jeremy Zehr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

lcpcli-0.1.1/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.1
+Name: lcpcli
+Version: 0.1.1
+Summary: Helper for converting CONLLU files and uploading the corpus to LCP
+Home-page: 
+Author: Jeremy Zehr and Jonathan Schaber
+Author-email: Jeremy Zehr <jeremy.zehr@uzh.ch>
+Project-URL: Homepage, https://gitlab.uzh.ch/LiRI/projects/lcpcli
+Project-URL: Issues, https://gitlab.uzh.ch/LiRI/projects/lcpcli/-/issues
+Keywords: corpus,linguistics,corpora,conll,tei,vert
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: lxml>=4.7.1
+Requires-Dist: lupa>=1.13
+Requires-Dist: xmltodict>=0.13
+Requires-Dist: jsonpickle>=3.0
+Requires-Dist: jsonschema>=4.21
+Requires-Dist: requests>=2.30.0
+Requires-Dist: py7zr>=0.20.5
+Requires-Dist: tqdm>=4.65.0
+Requires-Dist: types-tqdm>=4.65.0.1
+Requires-Dist: types-requests>=2.30.0.0
+
+# LCP CLI module
+
+> Helper for converting CONLLU files and uploading the corpus to LCP
+
+## Installation
+
+Clone this project along with its submodules:
+
+```bash
+git clone --recurse-submodules git@gitlab.uzh.ch:LiRI/projects/lcpcli.git
+```
+
+Make sure you have python 3.11 and pip installed in your local environment, then run:
+
+```bash
+./install.sh
+```
+
+## Usage
+
+Help:
+
+```bash
+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

lcpcli-0.1.1/README.md

@@ -0,0 +1,132 @@
+# LCP CLI module
+
+> Helper for converting CONLLU files and uploading the corpus to LCP
+
+## Installation
+
+Clone this project along with its submodules:
+
+```bash
+git clone --recurse-submodules git@gitlab.uzh.ch:LiRI/projects/lcpcli.git
+```
+
+Make sure you have python 3.11 and pip installed in your local environment, then run:
+
+```bash
+./install.sh
+```
+
+## Usage
+
+Help:
+
+```bash
+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

lcpcli-0.1.1/bin/lcpcli

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+python -m lcpcli $@