grecy 1.0__tar.gz

grecy-1.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jacobo Myerston
+
+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.

grecy-1.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.1
+Name: grecy
+Version: 1.0
+Summary: grecy installs six ancient Greek spaCy models that were trained using the Universal Dependency Proiel and Perseus treebanks.
+Author-email: Jacobo Myerston <jmyerston@ucsd.edu>
+License: MIT License
+        
+        Copyright (c) 2023 Jacobo Myerston
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/jmyerston/greCy
+Project-URL: Bug Tracker, https://github.com/jmyerston/greCy/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+# greCy
+## Ancient Greek models for spaCy
+
+greCy is a set of spaCy ancient Greek models and its installer. The models were trained using the [Perseus](https://universaldependencies.org/treebanks/grc_perseus/index.html) and  [Proiel UD](https://universaldependencies.org/treebanks/grc_proiel/index.html) corpora.
+
+### Installation
+
+First install the python package as usual:
+
+``` bash
+pip install -U grecy
+```
+
+Once the package is successfully installed, you can proceed to install any of the followings models:
+
+* grc_perseus_sm
+* grc_proiel_sm
+* grc_perseus_lg
+* grc_proiel_lg
+* grc_perseus_trf
+* grc_proiel_trf
+
+
+The models can be installed from the terminal with the commands below:
+
+```
+python -m grecy install MODEL
+```
+where you replace MODEL by any of the model names listed above.  The suffixes after the corpus name _sm, _lg, and _trf indicate the size of the model, which directly depends on the word embeddings used to train the models. The smallest models end in _sm (small) and are the less accurate ones: they are good for testing and building lightweight apps. The _lg and _trf are the large and transformer models which are more accurate. The _lg were trained using floret word vectors, and the _trf models use a special version of BERT that was pretrained with the largest Ancient Greek corpus available in the web. 
+
+
+### Loading
+
+As usual, you can load any of the six models with the following Python lines:
+
+```
+import spacy
+nlp = spacy.load("grc_proiel_XX")
+```
+Remember to replace  _XX  with the size of the model you would like to use, this means, _sm for small, _lg for large, and _trf for transformer. The _trf model is the most accurate but also the slowest.
+
+### Use
+
+spaCy is a powerful NLP library with many applications. The most basic of its function is the morpho-syntantic annotation of texts for further processing. A common routine is to load a model, create a doc object, and process a text:
+
+```
+import spacy
+nlp = spacy.load("grc_proiel_trf")
+
+text = "καὶ πρὶν μὲν ἐν κακοῖσι κειμένην ὅμως ἐλπίς μʼ ἀεὶ προσῆγε σωθέντος τέκνου ἀλκήν τινʼ εὑρεῖν κἀπικούρησιν δόμον"
+
+doc = nlp(text)
+
+for token in doc:
+    print(f'{token.text}, lemma: {token.lemma_} pos:{token.pos_}')
+    
+```
+
+#### The apostrophe issue
+
+Unfortunately, there is no consensus how to represent the Ancient Greek apostrophe. Modern Greek simply uses the regular apostrophe, but ancient texts available in Perseus and Perseus under Philologic use various unicode characters for the apostrophe. Instead of the apostrophe, we find the 'Greek koronis', 'modifier letter apostrophe', and 'right single quotation mark.' Provisionally, I have opted to use 'modifier letter apostrophe' in the corpora with which I trained the models. This means that, if you want the greCy models to properly handle the apostrophe, you have to make sure that the Ancient Greek texts that you are processing use the modifier letter apostrophe **ʼ** (U+02BC ). Otherwise the models will fail to lemmatize and tag some words in your texts that ends with an 'apostrophe'.
+
+
+
+
+
+
+
+
+
+
+

grecy-1.0/README.md

@@ -0,0 +1,72 @@
+# greCy
+## Ancient Greek models for spaCy
+
+greCy is a set of spaCy ancient Greek models and its installer. The models were trained using the [Perseus](https://universaldependencies.org/treebanks/grc_perseus/index.html) and  [Proiel UD](https://universaldependencies.org/treebanks/grc_proiel/index.html) corpora.
+
+### Installation
+
+First install the python package as usual:
+
+``` bash
+pip install -U grecy
+```
+
+Once the package is successfully installed, you can proceed to install any of the followings models:
+
+* grc_perseus_sm
+* grc_proiel_sm
+* grc_perseus_lg
+* grc_proiel_lg
+* grc_perseus_trf
+* grc_proiel_trf
+
+
+The models can be installed from the terminal with the commands below:
+
+```
+python -m grecy install MODEL
+```
+where you replace MODEL by any of the model names listed above.  The suffixes after the corpus name _sm, _lg, and _trf indicate the size of the model, which directly depends on the word embeddings used to train the models. The smallest models end in _sm (small) and are the less accurate ones: they are good for testing and building lightweight apps. The _lg and _trf are the large and transformer models which are more accurate. The _lg were trained using floret word vectors, and the _trf models use a special version of BERT that was pretrained with the largest Ancient Greek corpus available in the web. 
+
+
+### Loading
+
+As usual, you can load any of the six models with the following Python lines:
+
+```
+import spacy
+nlp = spacy.load("grc_proiel_XX")
+```
+Remember to replace  _XX  with the size of the model you would like to use, this means, _sm for small, _lg for large, and _trf for transformer. The _trf model is the most accurate but also the slowest.
+
+### Use
+
+spaCy is a powerful NLP library with many applications. The most basic of its function is the morpho-syntantic annotation of texts for further processing. A common routine is to load a model, create a doc object, and process a text:
+
+```
+import spacy
+nlp = spacy.load("grc_proiel_trf")
+
+text = "καὶ πρὶν μὲν ἐν κακοῖσι κειμένην ὅμως ἐλπίς μʼ ἀεὶ προσῆγε σωθέντος τέκνου ἀλκήν τινʼ εὑρεῖν κἀπικούρησιν δόμον"
+
+doc = nlp(text)
+
+for token in doc:
+    print(f'{token.text}, lemma: {token.lemma_} pos:{token.pos_}')
+    
+```
+
+#### The apostrophe issue
+
+Unfortunately, there is no consensus how to represent the Ancient Greek apostrophe. Modern Greek simply uses the regular apostrophe, but ancient texts available in Perseus and Perseus under Philologic use various unicode characters for the apostrophe. Instead of the apostrophe, we find the 'Greek koronis', 'modifier letter apostrophe', and 'right single quotation mark.' Provisionally, I have opted to use 'modifier letter apostrophe' in the corpora with which I trained the models. This means that, if you want the greCy models to properly handle the apostrophe, you have to make sure that the Ancient Greek texts that you are processing use the modifier letter apostrophe **ʼ** (U+02BC ). Otherwise the models will fail to lemmatize and tag some words in your texts that ends with an 'apostrophe'.
+
+
+
+
+
+
+
+
+
+
+

grecy-1.0/grecy/__main__.py

@@ -0,0 +1,126 @@
+import typer
+import subprocess
+import sys
+from .utilities.connections import access_to
+
+app = typer.Typer()
+
+@app.command()
+def install(model: str):
+
+    models = ["grc_perseus_sm","grc_perseus_lg","grc_perseus_trf","grc_proiel_sm","grc_proiel_lg","grc_proiel_trf"]
+
+    hf_url = "https://huggingface.co/"
+
+    if model in models:
+
+        # Checking the access to Hugging Face
+        if not access_to(hf_url):
+            print(f'The access to {hf_url} is not possible.')
+            print(f'Please, check the network connection.')
+            exit(0)
+
+        # The url for the model
+        https = hf_url + "Jacobo/" + model + "/resolve/main/" + model + "-any-py3-none-any.whl"
+
+        # The pip command
+        pip_command = "python -m pip install " + https
+
+        try:
+            process = subprocess.Popen(pip_command.split(" "),
+                                       bufsize=1,
+                                       stdout=subprocess.PIPE,
+                                       stderr=subprocess.PIPE,
+                                       universal_newlines=True)
+        except Exception as e:
+
+            print(f'There is a problem with  the command: {pip_command}')
+            print(f'Below the related information:')
+            print(f'{str(e)}')
+
+        else:
+
+            finished = process.poll()
+
+            if not finished:
+
+                print('\n' + f'Installing {model}.....')
+                print('\n' + f'Please wait, this could take some minutes.....' + '\n')
+
+                while True:
+
+                    msg = process.stdout.readline()
+                    print(msg.strip())
+                    return_code = process.poll()
+                    if return_code is not None:
+                        # The model was successfully installed
+                        # Printing the rest of the installation's output:
+                        for msg in process.stdout.readlines():
+                            print(msg.strip())
+                        break
+
+            else:
+                print(f'The model: {model} can not be installed' + '\n')
+                print("Please, check the model's name in the address below." + '\n')
+                print(https + '\n')
+                print('Error CODE', error, '\n')
+                # The model can not be installed
+                # Printing the rest of the error's output:
+                for msg in process.stderr.readline():
+                    print(msg)
+    else:
+        print('\n' + f'Please, check the model required. The options in greCy are:')
+        print([model for model in models])
+
+
+@app.command()
+def uninstall(model: str):
+
+    models = ["grc_perseus_sm","grc_perseus_lg","grc_perseus_trf","grc_proiel_sm","grc_proiel_lg","grc_proiel_trf"]
+
+    if model in models:
+
+        pip_command = "python -m pip uninstall --yes " + model
+
+        try:
+            process = subprocess.Popen(pip_command.split(" "),
+                                       bufsize=1,
+                                       stdout=subprocess.PIPE,
+                                       stderr=subprocess.PIPE,
+                                       universal_newlines=True)
+        except Exception as e:
+
+            print(f'There is a problem with the command: {pip_command}')
+            print(f'Below the related information:')
+            print(f'{str(e)}')
+
+        else:
+
+            error = process.stderr.readline()
+
+            if error:
+                print(error)
+                exit(0)
+
+            else:
+
+                while True:
+
+                    msg = process.stdout.readline()
+                    print(msg)
+                    return_code = process.poll()
+
+                    if return_code is not None:
+                        # The model has been uninstalled.
+                        # Printing the rest of the output:
+                        for msg in process.stdout.readlines():
+                            print(msg)
+                        break
+    else:
+        print(f'The model: {model} can not be uninstalled' + "\n")
+        print(f'Please, check the model. The options in greCy are:')
+        print([model for model in models])
+
+if __name__ == "__main__":
+
+    app()

grecy-1.0/grecy/utilities/connections.py

@@ -0,0 +1,12 @@
+import urllib.request
+
+
+def access_to(url: str):
+    # trying to open gfg
+    try:
+        urllib.request.urlopen(url)
+        return True
+
+    # trying to catch exception when internet is not ON.
+    except:
+        return False

grecy-1.0/grecy.egg-info/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.1
+Name: grecy
+Version: 1.0
+Summary: grecy installs six ancient Greek spaCy models that were trained using the Universal Dependency Proiel and Perseus treebanks.
+Author-email: Jacobo Myerston <jmyerston@ucsd.edu>
+License: MIT License
+        
+        Copyright (c) 2023 Jacobo Myerston
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/jmyerston/greCy
+Project-URL: Bug Tracker, https://github.com/jmyerston/greCy/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+# greCy
+## Ancient Greek models for spaCy
+
+greCy is a set of spaCy ancient Greek models and its installer. The models were trained using the [Perseus](https://universaldependencies.org/treebanks/grc_perseus/index.html) and  [Proiel UD](https://universaldependencies.org/treebanks/grc_proiel/index.html) corpora.
+
+### Installation
+
+First install the python package as usual:
+
+``` bash
+pip install -U grecy
+```
+
+Once the package is successfully installed, you can proceed to install any of the followings models:
+
+* grc_perseus_sm
+* grc_proiel_sm
+* grc_perseus_lg
+* grc_proiel_lg
+* grc_perseus_trf
+* grc_proiel_trf
+
+
+The models can be installed from the terminal with the commands below:
+
+```
+python -m grecy install MODEL
+```
+where you replace MODEL by any of the model names listed above.  The suffixes after the corpus name _sm, _lg, and _trf indicate the size of the model, which directly depends on the word embeddings used to train the models. The smallest models end in _sm (small) and are the less accurate ones: they are good for testing and building lightweight apps. The _lg and _trf are the large and transformer models which are more accurate. The _lg were trained using floret word vectors, and the _trf models use a special version of BERT that was pretrained with the largest Ancient Greek corpus available in the web. 
+
+
+### Loading
+
+As usual, you can load any of the six models with the following Python lines:
+
+```
+import spacy
+nlp = spacy.load("grc_proiel_XX")
+```
+Remember to replace  _XX  with the size of the model you would like to use, this means, _sm for small, _lg for large, and _trf for transformer. The _trf model is the most accurate but also the slowest.
+
+### Use
+
+spaCy is a powerful NLP library with many applications. The most basic of its function is the morpho-syntantic annotation of texts for further processing. A common routine is to load a model, create a doc object, and process a text:
+
+```
+import spacy
+nlp = spacy.load("grc_proiel_trf")
+
+text = "καὶ πρὶν μὲν ἐν κακοῖσι κειμένην ὅμως ἐλπίς μʼ ἀεὶ προσῆγε σωθέντος τέκνου ἀλκήν τινʼ εὑρεῖν κἀπικούρησιν δόμον"
+
+doc = nlp(text)
+
+for token in doc:
+    print(f'{token.text}, lemma: {token.lemma_} pos:{token.pos_}')
+    
+```
+
+#### The apostrophe issue
+
+Unfortunately, there is no consensus how to represent the Ancient Greek apostrophe. Modern Greek simply uses the regular apostrophe, but ancient texts available in Perseus and Perseus under Philologic use various unicode characters for the apostrophe. Instead of the apostrophe, we find the 'Greek koronis', 'modifier letter apostrophe', and 'right single quotation mark.' Provisionally, I have opted to use 'modifier letter apostrophe' in the corpora with which I trained the models. This means that, if you want the greCy models to properly handle the apostrophe, you have to make sure that the Ancient Greek texts that you are processing use the modifier letter apostrophe **ʼ** (U+02BC ). Otherwise the models will fail to lemmatize and tag some words in your texts that ends with an 'apostrophe'.
+
+
+
+
+
+
+
+
+
+
+

grecy-1.0/grecy.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE.txt
+README.md
+pyproject.toml
+requirements.txt
+grecy/__init__.py
+grecy/__main__.py
+grecy.egg-info/PKG-INFO
+grecy.egg-info/SOURCES.txt
+grecy.egg-info/dependency_links.txt
+grecy.egg-info/requires.txt
+grecy.egg-info/top_level.txt
+grecy/utilities/__init__.py
+grecy/utilities/connections.py

grecy-1.0/grecy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

grecy-1.0/grecy.egg-info/requires.txt

@@ -0,0 +1 @@
+spacy<4.0.0,>=3.5

grecy-1.0/grecy.egg-info/top_level.txt

@@ -0,0 +1 @@
+grecy

grecy-1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "grecy"
+version = "1.0"
+description = "grecy installs six ancient Greek spaCy models that were trained using the Universal Dependency Proiel and Perseus treebanks."
+readme = "README.md"
+requires-python = ">=3.10"
+license = {file = "LICENSE.txt"}
+authors = [
+  { name="Jacobo Myerston", email="jmyerston@ucsd.edu" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+dynamic = ["dependencies"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+[project.urls]
+"Homepage" = "https://github.com/jmyerston/greCy"
+"Bug Tracker" = "https://github.com/jmyerston/greCy/issues"

grecy-1.0/requirements.txt

@@ -0,0 +1 @@
+spacy>=3.5,<4.0.0

grecy-1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+