V2

.github/workflows/python-package.yml → .github/workflows/run-unit-tests.yml

@@ -1,30 +1,26 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
 name: Python package
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+on: [push]
 
 jobs:
   build:
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python 3.9
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: 3.9
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install flake8 pytest
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Install Argos Translate
+      run: |
+        python -m pip install .
     - name: Test with pytest
       run: |
         pytest -v

Developers.md

@@ -1,5 +1,7 @@
 # Developers
-Most active development happens in the `v2` branch, please make pull requests there
+Contributions welcome!
+
+Most active development happens in the `v2` branch, please make pull requests there.
 
 ## Running unit tests
 ```

ReleaseNotes.md

@@ -1,26 +1,34 @@
-1.9:
+# 2.0
+- Include dependencies in packages
+- Load configuration settings from file or environment variable
+- Improved logging
+- Refactoring for readability
+- Better automated unit testing and regression testing
+- Improved type checking
+
+# 1.9:
 - Add support for Byte Pair Encoding
 
-1.8:
+# 1.8:
 - Delete cached package files after they've been installed
 - Automatically update packages to newer version with package.Package.update
 
-1.7:
+# 1.7:
 - Improved examples and documentation
 - Use multiple links for redundancy and load balancing
 - Add logger namespace
 - CTranslate2 updates
 
-1.6:
+# 1.6:
 - [Argos Translate GUI](https://github.com/argosopentech/argos-translate-gui) to separate repo
 - Bug fixes
 - [File translation](https://github.com/dingedi/argos-translate-files)
 
-1.5:
+# 1.5:
 - Tag injection
 - Upgrade to CTranslate2 2.0
 
-1.4:
+# 1.4:
 - Better support for seq2seq sentence boundary detection
 - py2app support
 - GPU support
@@ -30,13 +38,13 @@
 - Consistently use pathlib.Path in package module instead of strings
 - Broke backwards compatibility with package.Package.remove
 
-1.3:
+# 1.3:
 - argospm CLI tool
 - CLI improvements
 - Experimental sentence boundary detection using OpenNMT Seq2Seq model
 - Removed requests dependency
 
-1.2:
+# 1.2:
 - Download packages from GUI
 - Multiple hypotheses in translations
 - Deprecated load_available_packages for get_available_packages
@@ -45,7 +53,7 @@
 - Broke backwards compatibility in translate.apply_packaged_translation
 - Broke backwards compatibility in ITranslate.split_into_paragraphs
 
-1.1:
+# 1.1:
 - Automatic downloading and installation of packages (https://github.com/uav4geo/LibreTranslate/issues/30)
 - Command Line Interface
 (https://github.com/argosopentech/argos-translate/issues/3)
@@ -55,5 +63,5 @@
 - Changed "length_penalty" to 0.2 (https://forum.opennmt.net/t/suggested-value-for-length-penalty/4134)
 - P2P model distribution support
 
-1.0:
+# 1.0:
 Hello World

argostranslate/__version__

@@ -0,0 +1 @@
+1.8.0

argostranslate/apis.py

@@ -2,115 +2,94 @@
 
 import json
 import sys
+from typing import Any, Dict
 from urllib import parse, request
 
 from argostranslate.models import ILanguageModel
 
+# https://github.com/argosopentech/LibreTranslate-py
+
 
 class LibreTranslateAPI:
     """Connect to the LibreTranslate API"""
 
     """Example usage:
-    from argostranslate.apis import LibreTranslateAPI
+    from libretranslatepy import LibreTranslateAPI
     lt = LibreTranslateAPI("https://translate.argosopentech.com/")
+    print(lt.translate("LibreTranslate is awesome!", "en", "es"))
+    # LibreTranslate es impresionante!
     print(lt.detect("Hello World"))
+    # [{"confidence": 0.6, "language": "en"}]
+
     print(lt.languages())
-    print(lt.translate("LibreTranslate is awesome!", "en", "es"))
+    # [{"code":"en", "name":"English"}]
     """
 
     DEFAULT_URL = "https://translate.argosopentech.com/"
 
-    def __init__(self, url: str = None, api_key: str = None):
+    def __init__(self, url: str | None = None, api_key: str | None = None):
         """Create a LibreTranslate API connection.
-
         Args:
-            url: The url of the LibreTranslate endpoint.
-            api_key: The API key.
+            url (str): The url of the LibreTranslate endpoint.
+            api_key (str): The API key.
         """
-
-        self.url = self.DEFAULT_URL if url is None else url
+        self.url = LibreTranslateAPI.DEFAULT_URL if url is None else url
         self.api_key = api_key
 
         # Add trailing slash
         assert len(self.url) > 0
         if self.url[-1] != "/":
             self.url += "/"
 
-    def translate(self, q: str, source: str = "en", target: str = "es") -> str:
+    def translate(self, q: str, source: str = "en", target: str = "es") -> Any:
         """Translate string
-
         Args:
-            q: The text to translate
-            source: The source language code (ISO 639)
-            target: The target language code (ISO 639)
-
-        Returns: The translated text
+            q (str): The text to translate
+            source (str): The source language code (ISO 639)
+            target (str): The target language code (ISO 639)
+        Returns:
+            str: The translated text
         """
-
         url = self.url + "translate"
-
-        params = {"q": q, "source": source, "target": target}
-
+        params: Dict[str, str] = {"q": q, "source": source, "target": target}
         if self.api_key is not None:
             params["api_key"] = self.api_key
-
         url_params = parse.urlencode(params)
-
         req = request.Request(url, data=url_params.encode())
-
         response = request.urlopen(req)
-
         response_str = response.read().decode()
-
         return json.loads(response_str)["translatedText"]
 
-    def languages(self):
-        """Retrieve list of supported languages.
-
-        Returns: A list of available languages ex. [{"code":"en", "name":"English"}]
+    def detect(self, q: str) -> Any:
+        """Detect the language of a single text.
+        Args:
+            q (str): Text to detect
+        Returns:
+            The detected languages ex: [{"confidence": 0.6, "language": "en"}]
         """
-
-        url = self.url + "languages"
-
-        params = dict()
-
+        url = self.url + "detect"
+        params: Dict[str, str] = {"q": q}
         if self.api_key is not None:
             params["api_key"] = self.api_key
-
         url_params = parse.urlencode(params)
-
         req = request.Request(url, data=url_params.encode())
-
         response = request.urlopen(req)
-
         response_str = response.read().decode()
-
         return json.loads(response_str)
 
-    def detect(self, q: str):
-        """Detect the language of a single text.
-
-        Args:
-            q: Text to detect
-
-        Returns: The detected languages ex. [{"confidence": 0.6, "language": "en"}]
+    def languages(self) -> Any:
+        """Retrieve list of supported languages.
+        Returns:
+            A list of available languages ex: [{"code":"en", "name":"English"}]
         """
-
-        url = self.url + "detect"
-
-        params = {"q": q}
-
+        url = self.url + "languages"
+        params: Dict[str, str] = dict()
         if self.api_key is not None:
             params["api_key"] = self.api_key
-
         url_params = parse.urlencode(params)
-
-        req = request.Request(url, data=url_params.encode())
-
+        req = request.Request(url, data=url_params.encode(), method="GET")
         response = request.urlopen(req)
-
         response_str = response.read().decode()
-
         return json.loads(response_str)
 
 

argostranslate/apply_bpe.py

@@ -45,7 +45,6 @@
 
 class BPE(object):
     def __init__(self, codes, merges=-1, separator="@@", vocab=None, glossaries=None):
-
         codes.seek(0)
         offset = 1
 
@@ -160,7 +159,6 @@ def _isolate_glossaries(self, word):
 
 
 def create_parser(subparsers=None):
-
     if subparsers:
         parser = subparsers.add_parser(
             "apply-bpe",
@@ -417,7 +415,7 @@ def isolate_glossary(word, glossary):
 if __name__ == "__main__":
 
     currentdir = os.path.dirname(
-        os.path.abspath(inspect.getfile(inspect.currentframe()))
+        os.path.abspath(inspect.getfile(inspect.currentframe()))  # type: ignore
     )
     newdir = os.path.join(currentdir, "subword_nmt")
     if os.path.isdir(newdir):