From 31a7f6a0224dec24845266da7c566adf1e728ba9 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerin.philip@research.iiit.ac.in>
Date: Fri, 11 Feb 2022 15:36:49 +0000
Subject: [PATCH 01/22] Improve README.md

Change README.md to reflect wider capabilities (C++ library, Python,
WebAssembly). Move a bulk of WebAssembly specific intructions to
`wasm/README.md`.
---
 README.md      | 159 ++++++++++++++++++++++++++++++-------------------
 doc/index.rst  |  13 +---
 wasm/README.md |  69 +++++++++++++++++++--
 3 files changed, 165 insertions(+), 76 deletions(-)

diff --git a/README.md b/README.md
index b70c818ec..62679dff5 100644
--- a/README.md
+++ b/README.md
@@ -1,87 +1,124 @@
-# Bergamot Translator
+<img src="https://browser.mt/images/about.jpg">
 
-[![CircleCI badge](https://img.shields.io/circleci/project/github/browsermt/bergamot-translator/main.svg?label=CircleCI)](https://circleci.com/gh/browsermt/bergamot-translator/)
+# bergamot-translator
 
-Bergamot translator provides a unified API for ([Marian NMT](https://marian-nmt.github.io/) framework based) neural machine translation functionality in accordance with the [Bergamot](https://browser.mt/) project that focuses on improving client-side machine translation in a web browser.
+[![native](https://github.com/browsermt/bergamot-translator/actions/workflows/native.yml/badge.svg)]()
+[![python + wasm](https://github.com/browsermt/bergamot-translator/actions/workflows/build.yml/badge.svg)]()
+[![PyPI version](https://badge.fury.io/py/bergamot.svg)](https://badge.fury.io/py/bergamot)
+[![twitter](https://img.shields.io/twitter/url.svg?label=Follow%20@BergamotProject&style=social&url=http://twitter.com/BergamotProject)](https://twitter.com/BergamotProject)
 
-## Build Instructions
+bergamot-translator enables client-side machine translation on the
+consumer-grade machine. Developed as part of the
+[Bergamot](https://browser.mt/) project, the library builds on top of:
+
+1. [Marian](https://marian-nmt.github.io/): Neural Machine Translation (NMT)
+   library. This repository uses the fork
+   [browsermt/marian-dev](https://github.com/browsermt/marian-dev), which
+   optimizes for faster inference on intel CPUs and WebAssembly support.
+2. [student models](https://github.com/browsermt/students): Compressed neural
+   models that enable translation on consumer-grade devices.
+
+bergamot-translator wraps marian to add sentence splitting, on-the-fly
+batching, HTML markup translation, and a more suitable API to develop
+applications. Development continuously tests the functionality on Windows,
+MacOS and Linux operating systems on `x86_64`. and WebAssembly cross-platform
+target in addition. `aarch64` native support is under development.
+
+## Usage
+
+### As a C++ library
+
+bergamot-translator uses the CMake build system. Use the library target
+`bergamot-translator` in projects that intend to build applications on top of
+the library. Latest developer documentation is available at
+[browser.mt/docs/main](https://browser.mt/docs/main).
+
+### In other languages
+
+We provide bindings to Python and JavaScript through WebAssembly.
+
+#### Python
+
+This repository provides a python module which also comes with  a command-line
+interface to use available models. This is available through PyPI.
 
-### Build Natively
-Create a folder where you want to build all the artifacts (`build-native` in this case) and compile
 
 ```bash
-mkdir build-native
-cd build-native
-cmake ../
-make -j2
+python3 -m pip install bergamot
 ```
 
-### Build WASM
-#### Prerequisite
+Find an example for a quick-start on Colab below:
 
-Building on wasm requires Emscripten toolchain. It can be downloaded and installed using following instructions:
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1AHpgewVJBFaupwAbZq0e6TdX6REx0Ul0)
 
-* Get the latest sdk: `git clone https://github.com/emscripten-core/emsdk.git`
-* Enter the cloned directory: `cd emsdk`
-* Install the sdk: `./emsdk install 3.1.8`
-* Activate the sdk: `./emsdk activate 3.1.8`
-* Activate path variables: `source ./emsdk_env.sh`
+For more comprehensive documentation of using the in python as a library see
+[browser.mt/docs/main/python.html](https://browser.mt/docs/main/python.html).
 
-#### <a name="Compile"></a> Compile
+#### JavaScript/WebAssembly
 
-To build a version that translates with higher speeds on Firefox Nightly browser, follow these instructions:
+WebAssembly and JavaScript support is developed for an offline-translation
+browser extension intended for use in Mozilla Firefox web-browser. emscripten
+is used to compile C/C++ sources to WebAssembly. You may use the pre-built
+`bergamot-translator-worker.js` and `bergamot-translator-worker.wasm` available
+from [releases](https://github.com/browsermt/bergamot-translator/releases).
 
-   1. Create a folder where you want to build all the artifacts (`build-wasm` in this case) and compile
-       ```bash
-       mkdir build-wasm
-       cd build-wasm
-       emcmake cmake -DCOMPILE_WASM=on ../
-       emmake make -j2
-       ```
+WebAssembly is available in Firefox and Google Chrome. It is also possible to
+use these through NodeJS. For an example of how to use this, please look at
+this [Hello World](./wasm/node-test.js) example.  For a complete demo that
+works locally in your modern browser see
+[mozilla.github.io/translate](https://mozilla.github.io/translate/).
 
-       The wasm artifacts (.js and .wasm files) will be available in the build directory ("build-wasm" in this case).
+WebAssembly is slower due to lack of optimized matrix-multiply primitives.
+Nightly builds of Mozilla Firefox have faster GEMM (Generalized Matrix
+Multiplication) capabilities and are expected to be slightly faster.
 
-   2. Enable SIMD Wormhole via Wasm instantiation API in generated artifacts
-       ```bash
-       bash ../wasm/patch-artifacts-enable-wormhole.sh
-       ```
+## Applications
 
-   3. Patch generated artifacts to import GEMM library from a separate wasm module
-       ```bash
-       bash ../wasm/patch-artifacts-import-gemm-module.sh
-       ```
+### translateLocally
 
-To build a version that runs on all browsers (including Firefox Nightly) but translates slowly, follow these instructions:
+For a cross platform batteries included GUI application that builds on top of
+bergamot-translator, checkout
+[translateLocally](https://github.com/XapaJIaMnu/translateLocally).
+translateLocally provides model downloading from a repository and curates
+available models. 
 
-  1. Create a folder where you want to build all the artifacts (`build-wasm` in this case) and compile
-      ```bash
-      mkdir build-wasm
-      cd build-wasm
-      emcmake cmake -DCOMPILE_WASM=on -DWORMHOLE=off ../
-      emmake make -j2
-      ```
+### Browser Extension
 
-  2. Patch generated artifacts to import GEMM library from a separate wasm module
-       ```bash
-       bash ../wasm/patch-artifacts-import-gemm-module.sh
-       ```
+Mozilla, as part of Bergamot Project builds and maintains
+[firefox-translations](https://github.com/mozilla/firefox-translations/). The
+official Firefox extension uses WebAssembly.
 
-#### Recompiling
-As long as you don't update any submodule, just follow [Compile](#Compile) steps.\
-If you update a submodule, execute following command in repository root folder before executing
-[Compile](#Compile) steps.
-```bash
-git submodule update --init --recursive
-```
+See
+[jelmervdl/firefox-translations](https://github.com/jelmervdl/firefox-translations/)
+for Chrome extension (Manifest V2), which in addition to WebAssembly, supports
+faster local translation via [Native
+Messaging](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging)
+supported by
+[translateLocally](https://github.com/XapaJIaMnu/translateLocally).
+
+
+## Contributing
+
+We appreciate all contributions. There are several ways to contribute to this
+project.
 
+1. **Code**: Improvements to the source are always welcome. If you are planning to
+   contribute back bug-fixes to this repository, please do so without any
+   further discussion.  If you plan to contribute new features, utility functions,
+   or extensions to the core, please
+   [discuss](https://github.com/browsermt/bergamot-translator/discussions) the
+   feature with us first.
+2. **Models**: Bergamot, being a wrapper on marian should comfortably work with
+   models trained using marian. We prefer models that are trained following the
+   recipe in
+   [browsermt/students](https://github.com/browsermt/students/tree/master/train-student)
+   so that they are smaller in size and enable fast inference on the
+   consumer-grade machine.
 
-## How to use
+## Acknowledgements
 
-### Using Native version
+This project has received funding from the European Union’s Horizon 2020
+research and innovation programme under grant agreement No 825303.
 
-The builds generate library that can be integrated to any project. All the public header files are specified in `src` folder.\
-A short example of how to use the APIs is provided in `app/main.cpp` file.
 
-### Using WASM version
 
-Please follow the `README` inside the `wasm` folder of this repository that demonstrates how to use the translator in JavaScript.
diff --git a/doc/index.rst b/doc/index.rst
index 54dc1e8dc..6bb4ed8cd 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,7 +1,7 @@
-Welcome to Bergamot Translator's documentation!
+bergamot-translator: Developer Documentation
 ===============================================
 
-|buildcpu| |tests| |release| |license|
+|release| |license|
 
 Bergamot translator provides a unified API for (Marian NMT framework based)
 neural machine translation functionality in accordance with the Bergamot
@@ -26,15 +26,6 @@ Indices and tables
 
 * :ref:`genindex`
 
-
-.. |buildcpu| image:: https://img.shields.io/jenkins/s/http/vali.inf.ed.ac.uk/jenkins/view/browsermt/job/bergamot-translator.svg?label=CPU%20Build
-   :target: http://vali.inf.ed.ac.uk/jenkins/job/bergamot-translator
-   :alt: CPU build status
-
-.. |tests| image:: https://img.shields.io/jenkins/s/http/vali.inf.ed.ac.uk/jenkins/view/marian/job/bergamot-translator-regression-tests.svg?label=Tests
-   :target: http://vali.inf.ed.ac.uk/jenkins/job/bergamot-translator-regression-tests/
-   :alt: Tests status
-
 .. |license| image:: https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg
    :target: https://opensource.org/licenses/MPL-2.0
    :alt: License: MPL
diff --git a/wasm/README.md b/wasm/README.md
index 883f80dc5..ba3eb55f3 100644
--- a/wasm/README.md
+++ b/wasm/README.md
@@ -1,12 +1,73 @@
-# Using Bergamot Translator in JavaScript
+# Javascript and WebAssembly
 
-All the instructions below are meant to run from the current directory.
+## Build WebAssembly
 
-## Using JS APIs
+### Prerequisites
+
+Building on wasm requires Emscripten toolchain. It can be downloaded and
+installed using following instructions:
+
+* Get the latest sdk: `git clone https://github.com/emscripten-core/emsdk.git`
+* Enter the cloned directory: `cd emsdk`
+* Install the lastest sdk tools: `./emsdk install 2.0.9`
+* Activate the latest sdk tools: `./emsdk activate 2.0.9`
+* Activate path variables: `source ./emsdk_env.sh`
+
+### Compile
+
+To build a version that translates with higher speeds on Firefox Nightly browser, follow these instructions:
+
+   1. Create a folder where you want to build all the artifacts (`build-wasm` in this case) and compile
+       ```bash
+       mkdir build-wasm
+       cd build-wasm
+       emcmake cmake -DCOMPILE_WASM=on ../
+       emmake make -j2
+       ```
+
+       The wasm artifacts (.js and .wasm files) will be available in the build directory ("build-wasm" in this case).
+
+   2. Enable SIMD Wormhole via Wasm instantiation API in generated artifacts
+       ```bash
+       bash ../wasm/patch-artifacts-enable-wormhole.sh
+       ```
+
+   3. Patch generated artifacts to import GEMM library from a separate wasm module
+       ```bash
+       bash ../wasm/patch-artifacts-import-gemm-module.sh
+       ```
+
+To build a version that runs on all browsers (including Firefox Nightly) but translates slowly, follow these instructions:
+
+  1. Create a folder where you want to build all the artifacts (`build-wasm` in this case) and compile
+      ```bash
+      mkdir build-wasm
+      cd build-wasm
+      emcmake cmake -DCOMPILE_WASM=on -DWORMHOLE=off ../
+      emmake make -j2
+      ```
+
+  2. Patch generated artifacts to import GEMM library from a separate wasm module
+       ```bash
+       bash ../wasm/patch-artifacts-import-gemm-module.sh
+       ```
+
+### Recompiling
+
+As long as you don't update any submodule, just follow [Compile](#Compile) steps.\
+If you update a submodule, execute following command in repository root folder before executing
+[Compile](#Compile) steps.
+```bash
+git submodule update --init --recursive
+```
+
+## Using in JavaScript
+
+### Using JS APIs
 
 Please refer to the file `test_page/js/worker.js` that demonstrates how to use the bergamot translator in JavaScript via a `<script>` tag.
 
-## Demo
+### Demo
 
 * Download bergamot model files required for translation
 

From e4c903efa57a6195d05271f03f2da4417dffa26d Mon Sep 17 00:00:00 2001
From: Jerin Philip <jphilip@ed.ac.uk>
Date: Tue, 15 Feb 2022 15:10:46 +0000
Subject: [PATCH 02/22] Pass on arg

---
 bindings/python/repository.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/bindings/python/repository.py b/bindings/python/repository.py
index a8e4a79c1..11ae0d914 100644
--- a/bindings/python/repository.py
+++ b/bindings/python/repository.py
@@ -187,7 +187,7 @@ def modelConfigPath(self, name: str, code: str) -> PathLike:
         )
 
     def models(self, name: str, filter_downloaded: bool = True) -> t.List[str]:
-        return self.repositories.get(name, self.default_repository).models()
+        return self.repositories.get(name, self.default_repository).models(filter_downloaded)
 
     def model(self, name: str, model_identifier: str) -> t.Any:
         return self.repositories.get(name, self.default_repository).model(

From 620380c6b808fbf7dc0a4434be04595841c71ff4 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jphilip@ed.ac.uk>
Date: Tue, 15 Feb 2022 15:11:00 +0000
Subject: [PATCH 03/22] Basic pytest wiring

---
 bindings/python/test_all.py | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 bindings/python/test_all.py

diff --git a/bindings/python/test_all.py b/bindings/python/test_all.py
new file mode 100644
index 000000000..dda114220
--- /dev/null
+++ b/bindings/python/test_all.py
@@ -0,0 +1,34 @@
+import pytest
+
+from bergamot import REPOSITORY
+from bergamot import ResponseOptions, Service, ServiceConfig, VectorString
+
+
+def test_basic():
+    keys = ['browsermt']
+    config = ServiceConfig(numWorkers=1, logLevel='critical')
+    service = Service(config)
+    for repository in keys:
+        models = REPOSITORY.models(repository, filter_downloaded=False)
+        for model in models:
+            REPOSITORY.download(repository, model)
+
+        for modelId in models:
+            configPath = REPOSITORY.modelConfigPath(repository, modelId)
+            model = service.modelFromConfigPath(configPath)
+            options = ResponseOptions(
+                alignment=True, qualityScores=True, HTML=False
+            )
+            print(repository, modelId)
+            source = "1 2 3 4 5 6 7 8 9"
+            responses = service.translate(model, VectorString([source]), options)
+            for response in responses:
+                print(response.target.text, end="")
+            print()
+
+
+
+
+
+if __name__ == '__main__':
+    test_basic()

From 92fa20e4d4229932622e85887f6a82bd3edbfca6 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jphilip@ed.ac.uk>
Date: Tue, 15 Feb 2022 15:25:00 +0000
Subject: [PATCH 04/22] Export alignments from python

---
 bindings/python/bergamot.cpp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/bindings/python/bergamot.cpp b/bindings/python/bergamot.cpp
index 5e9e830f9..6b4d88ccd 100644
--- a/bindings/python/bergamot.cpp
+++ b/bindings/python/bergamot.cpp
@@ -172,6 +172,10 @@ PYBIND11_MODULE(_bergamot, m) {
   py::bind_vector<std::vector<std::string>>(m, "VectorString");
   py::bind_vector<std::vector<Response>>(m, "VectorResponse");
 
+  py::bind_vector<std::vector<float>>(m, "VectorFloat");
+  py::bind_vector<Alignment>(m, "Alignment");
+  py::bind_vector<Alignments>(m, "Alignments");
+
   py::enum_<ConcatStrategy>(m, "ConcatStrategy")
       .value("FAITHFUL", ConcatStrategy::FAITHFUL)
       .value("SPACE", ConcatStrategy::SPACE)

From 45099cb0c6485eef874e5d05d890640a7306f372 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jphilip@ed.ac.uk>
Date: Tue, 15 Feb 2022 15:25:39 +0000
Subject: [PATCH 05/22] print alignments for now

---
 bindings/python/test_all.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/bindings/python/test_all.py b/bindings/python/test_all.py
index dda114220..c214c3654 100644
--- a/bindings/python/test_all.py
+++ b/bindings/python/test_all.py
@@ -24,6 +24,7 @@ def test_basic():
             responses = service.translate(model, VectorString([source]), options)
             for response in responses:
                 print(response.target.text, end="")
+                print(response.alignments)
             print()
 
 

From efab6d495dd5b5db5ce3fd4c5c83e1f62501fdef Mon Sep 17 00:00:00 2001
From: Jerin Philip <jphilip@ed.ac.uk>
Date: Tue, 15 Feb 2022 15:26:26 +0000
Subject: [PATCH 06/22] Apply formatting

---
 bindings/python/repository.py |  4 +++-
 bindings/python/test_all.py   | 17 +++++------------
 2 files changed, 8 insertions(+), 13 deletions(-)

diff --git a/bindings/python/repository.py b/bindings/python/repository.py
index 11ae0d914..a13257641 100644
--- a/bindings/python/repository.py
+++ b/bindings/python/repository.py
@@ -187,7 +187,9 @@ def modelConfigPath(self, name: str, code: str) -> PathLike:
         )
 
     def models(self, name: str, filter_downloaded: bool = True) -> t.List[str]:
-        return self.repositories.get(name, self.default_repository).models(filter_downloaded)
+        return self.repositories.get(name, self.default_repository).models(
+            filter_downloaded
+        )
 
     def model(self, name: str, model_identifier: str) -> t.Any:
         return self.repositories.get(name, self.default_repository).model(
diff --git a/bindings/python/test_all.py b/bindings/python/test_all.py
index c214c3654..b91ec575a 100644
--- a/bindings/python/test_all.py
+++ b/bindings/python/test_all.py
@@ -1,12 +1,10 @@
 import pytest
-
-from bergamot import REPOSITORY
-from bergamot import ResponseOptions, Service, ServiceConfig, VectorString
+from bergamot import REPOSITORY, ResponseOptions, Service, ServiceConfig, VectorString
 
 
 def test_basic():
-    keys = ['browsermt']
-    config = ServiceConfig(numWorkers=1, logLevel='critical')
+    keys = ["browsermt"]
+    config = ServiceConfig(numWorkers=1, logLevel="critical")
     service = Service(config)
     for repository in keys:
         models = REPOSITORY.models(repository, filter_downloaded=False)
@@ -16,9 +14,7 @@ def test_basic():
         for modelId in models:
             configPath = REPOSITORY.modelConfigPath(repository, modelId)
             model = service.modelFromConfigPath(configPath)
-            options = ResponseOptions(
-                alignment=True, qualityScores=True, HTML=False
-            )
+            options = ResponseOptions(alignment=True, qualityScores=True, HTML=False)
             print(repository, modelId)
             source = "1 2 3 4 5 6 7 8 9"
             responses = service.translate(model, VectorString([source]), options)
@@ -28,8 +24,5 @@ def test_basic():
             print()
 
 
-
-
-
-if __name__ == '__main__':
+if __name__ == "__main__":
     test_basic()

From 0843f5dd42f017f0010e21b4919b332bb6c5a8e2 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jphilip@ed.ac.uk>
Date: Tue, 15 Feb 2022 15:27:28 +0000
Subject: [PATCH 07/22] Include python bytecodes to gitignore

---
 .gitignore | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/.gitignore b/.gitignore
index 64c1aa3a7..1e71848e5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -23,3 +23,5 @@ wasm/test_page/js/bergamot-translator-worker.*
 
 # VSCode
 .vscode
+
+*.pyc

From 8212a519555751ef9ae67db2075fbb460c63c069 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jphilip@ed.ac.uk>
Date: Tue, 15 Feb 2022 15:39:55 +0000
Subject: [PATCH 08/22] Fix typecheck error

---
 bindings/python/repository.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/bindings/python/repository.py b/bindings/python/repository.py
index a13257641..b5fee889d 100644
--- a/bindings/python/repository.py
+++ b/bindings/python/repository.py
@@ -32,7 +32,7 @@ def update(self):
         pass
 
     @abstractmethod
-    def models(self) -> t.List[str]:
+    def models(self, filter_downloaded: bool) -> t.List[str]:
         """returns identifiers for available models"""
         pass
 

From 9d7fd7158ce56377d7a7e1d79f187ff218e91dd3 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Tue, 15 Feb 2022 18:52:54 +0000
Subject: [PATCH 09/22] Move tests into a test-folder

Following
https://docs.pytest.org/en/6.2.x/goodpractices.html#tests-outside-application-code
---
 bindings/python/{ => tests}/test_all.py | 1 +
 1 file changed, 1 insertion(+)
 rename bindings/python/{ => tests}/test_all.py (98%)

diff --git a/bindings/python/test_all.py b/bindings/python/tests/test_all.py
similarity index 98%
rename from bindings/python/test_all.py
rename to bindings/python/tests/test_all.py
index b91ec575a..ca976d4ff 100644
--- a/bindings/python/test_all.py
+++ b/bindings/python/tests/test_all.py
@@ -1,3 +1,4 @@
+# type: ignore
 import pytest
 from bergamot import REPOSITORY, ResponseOptions, Service, ServiceConfig, VectorString
 

From 9537f75af889a796d39fde0d5088cd1acba56b9e Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Wed, 16 Feb 2022 00:01:23 +0000
Subject: [PATCH 10/22] Include tests within setup.py

---
 bindings/python/__init__.py       | 1 +
 bindings/python/tests/test_all.py | 3 ++-
 setup.py                          | 2 +-
 3 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/bindings/python/__init__.py b/bindings/python/__init__.py
index 5855a4faf..4467935a3 100644
--- a/bindings/python/__init__.py
+++ b/bindings/python/__init__.py
@@ -16,3 +16,4 @@
 provide a (model-provider: str, model-code: str) based query mechanism to
 get models.
 """
+
diff --git a/bindings/python/tests/test_all.py b/bindings/python/tests/test_all.py
index ca976d4ff..3400b4bf5 100644
--- a/bindings/python/tests/test_all.py
+++ b/bindings/python/tests/test_all.py
@@ -5,10 +5,11 @@
 
 def test_basic():
     keys = ["browsermt"]
+    models = ['de-en-tiny']
     config = ServiceConfig(numWorkers=1, logLevel="critical")
     service = Service(config)
     for repository in keys:
-        models = REPOSITORY.models(repository, filter_downloaded=False)
+        # models = REPOSITORY.models(repository, filter_downloaded=False)
         for model in models:
             REPOSITORY.download(repository, model)
 
diff --git a/setup.py b/setup.py
index 51161a3c0..f47330bbb 100644
--- a/setup.py
+++ b/setup.py
@@ -207,7 +207,7 @@ def run(self):
     extras_require={"test": ["pytest>=6.0"]},
     license_files=("LICENSE",),
     python_requires=">=3.6",
-    packages=["bergamot"],
+    packages=["bergamot", "bergamot.tests"],
     package_dir={"bergamot": "bindings/python"},
     install_requires=["requests", "pyyaml>=5.1", "appdirs"],
     entry_points={

From dda0f77d7fb8c5bc9ee5401f4ab192118ea8ccf2 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Wed, 16 Feb 2022 00:13:44 +0000
Subject: [PATCH 11/22] Apply formatting

---
 bindings/python/__init__.py       | 1 -
 bindings/python/tests/test_all.py | 2 +-
 2 files changed, 1 insertion(+), 2 deletions(-)

diff --git a/bindings/python/__init__.py b/bindings/python/__init__.py
index 4467935a3..5855a4faf 100644
--- a/bindings/python/__init__.py
+++ b/bindings/python/__init__.py
@@ -16,4 +16,3 @@
 provide a (model-provider: str, model-code: str) based query mechanism to
 get models.
 """
-
diff --git a/bindings/python/tests/test_all.py b/bindings/python/tests/test_all.py
index 3400b4bf5..8a4594689 100644
--- a/bindings/python/tests/test_all.py
+++ b/bindings/python/tests/test_all.py
@@ -5,7 +5,7 @@
 
 def test_basic():
     keys = ["browsermt"]
-    models = ['de-en-tiny']
+    models = ["de-en-tiny"]
     config = ServiceConfig(numWorkers=1, logLevel="critical")
     service = Service(config)
     for repository in keys:

From ea45a1b49d28c78a89a2db8e935cd734adfd1aa3 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Fri, 18 Feb 2022 20:14:47 +0000
Subject: [PATCH 12/22] No coverage for repository, remove main from test_all

---
 bindings/python/repository.py     | 2 +-
 bindings/python/tests/test_all.py | 4 ----
 2 files changed, 1 insertion(+), 5 deletions(-)

diff --git a/bindings/python/repository.py b/bindings/python/repository.py
index b5fee889d..a270f0680 100644
--- a/bindings/python/repository.py
+++ b/bindings/python/repository.py
@@ -15,7 +15,7 @@
 APP = "bergamot"
 
 
-class Repository(ABC):
+class Repository(ABC): # pragma: no cover
     """
     An interface for several repositories. Intended to enable interchangable
     use of translateLocally and Mozilla repositories for usage through python.
diff --git a/bindings/python/tests/test_all.py b/bindings/python/tests/test_all.py
index 8a4594689..07a87aa01 100644
--- a/bindings/python/tests/test_all.py
+++ b/bindings/python/tests/test_all.py
@@ -24,7 +24,3 @@ def test_basic():
                 print(response.target.text, end="")
                 print(response.alignments)
             print()
-
-
-if __name__ == "__main__":
-    test_basic()

From fdb6d6bfd4702a1c68c99293ac600cc55b7077c3 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Fri, 18 Feb 2022 20:18:26 +0000
Subject: [PATCH 13/22] Add a coverage script

---
 scripts/python-test.sh | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 scripts/python-test.sh

diff --git a/scripts/python-test.sh b/scripts/python-test.sh
new file mode 100644
index 000000000..c5fc9bf06
--- /dev/null
+++ b/scripts/python-test.sh
@@ -0,0 +1,17 @@
+#!/bin/bash
+
+function run_coverage {
+    SOURCE_DIR=$(python3 -c 'import bergamot as _; print(_.__path__[0])')
+    coverage run -a --source ${SOURCE_DIR} -m bergamot ls
+    coverage run -a --source ${SOURCE_DIR} -m bergamot download # Download all models
+    coverage run -a --source ${SOURCE_DIR} -m bergamot translate -m en-de-tiny <<< "Hello World"
+    coverage run -a --source ${SOURCE_DIR} -m bergamot translate -m en-de-tiny de-en-tiny <<< "Hello World"
+    coverage run -a --source ${SOURCE_DIR} -m pytest --pyargs bergamot -rP
+}
+
+coverage erase
+run_coverage # Run once.
+run_coverage # Run again, to activate a few else paths.
+coverage report
+coverage html
+

From f8f06bef16fb0c7f2da3c69da4b7a736c53ff30f Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Fri, 18 Feb 2022 20:24:26 +0000
Subject: [PATCH 14/22] Consolidate python runs into a bash script, use it at
 github workflow

---
 scripts/python-test.sh | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/scripts/python-test.sh b/scripts/python-test.sh
index c5fc9bf06..8ef48bf04 100644
--- a/scripts/python-test.sh
+++ b/scripts/python-test.sh
@@ -1,17 +1,24 @@
 #!/bin/bash
 
+set -eo pipefail;
+
 function run_coverage {
     SOURCE_DIR=$(python3 -c 'import bergamot as _; print(_.__path__[0])')
     coverage run -a --source ${SOURCE_DIR} -m bergamot ls
     coverage run -a --source ${SOURCE_DIR} -m bergamot download # Download all models
     coverage run -a --source ${SOURCE_DIR} -m bergamot translate -m en-de-tiny <<< "Hello World"
     coverage run -a --source ${SOURCE_DIR} -m bergamot translate -m en-de-tiny de-en-tiny <<< "Hello World"
+    coverage run -a --source ${SOURCE_DIR} -m bergamot download -r opus -m eng-fin-tiny # Download specific model from opus
+    coverage run -a --source ${SOURCE_DIR} -m bergamot translate --model eng-fin-tiny --repository opus <<< "Hello World"
+    coverage run -a --source ${SOURCE_DIR} -m bergamot download -m eng-fin-tiny -r opus
+    coverage run -a --source ${SOURCE_DIR} -m bergamot ls -r opus
     coverage run -a --source ${SOURCE_DIR} -m pytest --pyargs bergamot -rP
 }
 
 coverage erase
+
 run_coverage # Run once.
 run_coverage # Run again, to activate a few else paths.
-coverage report
+
 coverage html
 

From b60b3e236086ffebae19ae51fb0d3f742653d09e Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Fri, 18 Feb 2022 20:25:30 +0000
Subject: [PATCH 15/22] Apply formatting: black + isort

---
 bindings/python/repository.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/bindings/python/repository.py b/bindings/python/repository.py
index a270f0680..abce5b1d3 100644
--- a/bindings/python/repository.py
+++ b/bindings/python/repository.py
@@ -15,7 +15,7 @@
 APP = "bergamot"
 
 
-class Repository(ABC): # pragma: no cover
+class Repository(ABC):  # pragma: no cover
     """
     An interface for several repositories. Intended to enable interchangable
     use of translateLocally and Mozilla repositories for usage through python.

From eb8add8efab13f7209df35eaa5e6d831acd870af Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Fri, 18 Feb 2022 21:24:58 +0000
Subject: [PATCH 16/22] Add a toJSON method, just to try accessing alignments

---
 bindings/python/tests/test_all.py |  5 ++---
 bindings/python/utils.py          | 27 ++++++++++++++++++++++++++-
 2 files changed, 28 insertions(+), 4 deletions(-)

diff --git a/bindings/python/tests/test_all.py b/bindings/python/tests/test_all.py
index 07a87aa01..e3c032a19 100644
--- a/bindings/python/tests/test_all.py
+++ b/bindings/python/tests/test_all.py
@@ -1,6 +1,7 @@
 # type: ignore
 import pytest
 from bergamot import REPOSITORY, ResponseOptions, Service, ServiceConfig, VectorString
+from bergamot.utils import toJSON
 
 
 def test_basic():
@@ -21,6 +22,4 @@ def test_basic():
             source = "1 2 3 4 5 6 7 8 9"
             responses = service.translate(model, VectorString([source]), options)
             for response in responses:
-                print(response.target.text, end="")
-                print(response.alignments)
-            print()
+                print(toJSON(response, indent=4))
diff --git a/bindings/python/utils.py b/bindings/python/utils.py
index 3164c171c..1adc0f5ce 100644
--- a/bindings/python/utils.py
+++ b/bindings/python/utils.py
@@ -2,8 +2,10 @@
 
 import requests
 import yaml
-
+import json
+from ._bergamot import Response, AnnotatedText, Alignments
 from .typing_utils import URL, PathLike
+import typing as t
 
 
 def download_resource(url: URL, save_location: PathLike, force_download=False):
@@ -50,3 +52,26 @@ def patch_marian_for_bergamot(
     # Write-out.
     with open(bergamot_config_path, "w") as output_file:
         print(yaml.dump(data, sort_keys=False), file=output_file)
+
+
+def toJSON(response: Response, *args, **kwargs) -> str:
+    def toPyNative(annotatedText: AnnotatedText) -> t.Dict[t.Any, t.Any]:
+        result = []
+        for sentenceIdx in range(annotatedText.numSentences()):
+            wordLs = []
+            for wordIdx in range(annotatedText.numWords(sentenceIdx)):
+                word = annotatedText.wordAsByteRange(sentenceIdx, wordIdx)
+                wordLs.append((word.begin, word.end))
+            result.append(wordLs)
+
+        return {
+            "text": annotatedText.text,
+            "annotation": result
+        }
+
+
+    return json.dumps({
+        "source": toPyNative(response.source),
+        "target": toPyNative(response.target),
+        "alignments": list(response.alignments)
+    }, *args, **kwargs)

From 2bf14ab15465798010f4ddc2971d25861a213c44 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Sat, 19 Feb 2022 12:06:07 +0000
Subject: [PATCH 17/22] Let's add the notebook and see if we can fit this
 somewhere

---
 bindings/python/tests/test_html.py | 127 +++++++++++++++++++++++++++++
 1 file changed, 127 insertions(+)
 create mode 100644 bindings/python/tests/test_html.py

diff --git a/bindings/python/tests/test_html.py b/bindings/python/tests/test_html.py
new file mode 100644
index 000000000..c60e4a655
--- /dev/null
+++ b/bindings/python/tests/test_html.py
@@ -0,0 +1,127 @@
+# type: ignore
+from bergamot import REPOSITORY, ResponseOptions, Service, ServiceConfig, VectorString
+import pytest
+from collections import Counter
+from string import whitespace
+
+try:
+    from lxml import etree, html
+except:
+    raise ImportError("Please install lxml, the html tests require these")
+
+
+def test_html():
+    MODEL = 'en-de-tiny'
+    config = ServiceConfig(numWorkers=4, logLevel='warn')
+    service = Service(config)
+    config_path = REPOSITORY.modelConfigPath('browsermt', MODEL)
+    model = service.modelFromConfigPath(config_path)
+
+    example ="""
+<div class="wrap">
+    <div class="image-wrap"><img src="/images/about.jpg" alt=""></div>
+    <h2 id="the-bergamot-project">Das Projekt Bergamot</h2>
+    <p>Das Bergamot-Projekt wird die Übersetzung der Client-Seite der Maschine in einem Webbrowser ergänzen und verbessern.</p>
+    <p>Im Gegensatz zu aktuellen <b>Cloud-basierten Optionen</b>, die di<s>rekt</s> auf den Rechnern der Nutzer laufen, die Bürgerinnen und Bürger, ihre Privatsphäre zu bewahren und erhöht die Verbreitung von Sprachtechnologien in Europa in verschiedenen Sektoren, die Vertraulichkeit erfordern. Freie Software, die mit einem Open-Source-Webbrowser wie Mozilla Firefox integriert ist, wird die Akzeptanz von unten nach oben durch Nicht-Experten ermöglichen, was zu Kosteneinsparungen für private und öffentliche Nutzer führt, die andernfalls Übersetzungen beschaffen oder einsprachig arbeiten würden.</p>
+    <p>Bergamot ist ein Konsortium, das von der Universität Edinburgh mit den Partnern Charles University in Prag, der University of Sheffield, der University of Tartu und Mozilla koordiniert wird.</p>
+</div>
+"""
+
+    def translate(src, HTML=True):
+        options = ResponseOptions(HTML=HTML)
+        responses = service.translate(model, VectorString([src]), options)
+        return responses[0].target.text
+
+    def get_surrounding_text(el):
+        """
+        Places for spaces: 0 <b> 1 … 2 </b> 3
+        0 before_open: prev.tail[-1] if prev else parent.text[-1]
+        1 after_open: elem.text[0]
+        2 before_close: last_child.tail[-1] if last_child else elem.text[-1]
+        3 after_close: elem.tail[0]
+        """
+        before_open = el.getprevious().tail if el.getprevious() is not None else el.getparent().text
+        after_open = el.text
+        last_child = next(el.iterchildren(reversed=True), None)
+        before_close = last_child.tail if last_child is not None else el.text
+        after_close = el.tail
+        return [before_open, after_open, before_close, after_close]
+
+    def has_surrounding_text(el):
+        return [
+            text is not None and text.strip() != ""
+            for text in get_surrounding_text(el)
+        ]
+
+    def has_surrounding_spaces(el):
+        return [
+            isinstance(text, str) and len(text) > 0 and text[index] in whitespace
+            for text, index in zip(get_surrounding_text(el), [-1, 0, -1, 0])
+        ]
+
+
+    def format_whitespace(slots):
+        return '{}<t>{}…{}</t>{}'.format(*[
+            '␣' if slot else '⊘'
+            for slot in slots
+        ])
+
+    def format_element(el):
+        return '<{}{}>'.format(el.tag, ''.join(
+            f' {key}="{val}"'
+            for key, val in el.items()
+            if key != 'x-test-id'
+        ))
+
+    def clean_html(src):
+        tree = html.fromstring(src)
+        return html.tostring(tree, encoding='utf-8').decode()
+
+    def compare_html(src, translate):
+        """Marks tags, then translates and compares translated HTML"""
+        src_tree = html.fromstring(src)
+        src_elements = {
+            str(n): element for n, element in enumerate(src_tree.iter(), 1)
+        }
+        # Assign each element a unique id to help it correlate after translation
+        for n, element in src_elements.items():
+            element.set('x-test-id', n)
+        src = html.tostring(src_tree, encoding='utf-8').decode()
+
+        tgt = translate(src)
+        tgt_tree = html.fromstring(tgt)
+
+        # Test if all elements are referenced once
+        print("Elements referenced:")
+        tgt_element_count = Counter(element.get('x-test-id') for element in tgt_tree.iter())
+        for n, element in src_elements.items():
+            count = tgt_element_count[n]
+            if count != 1:
+                print(f"{count}: {element!r}")
+
+        # Test whether all elements have text around them (i.e. no empty elements
+        # that should not be empty)
+        print("Elements with missing text:")
+        for tgt_element in tgt_tree.iter():
+            n = tgt_element.get('x-test-id')
+            src_element = src_elements[n]
+            tgt_text = has_surrounding_text(tgt_element)
+            src_text = has_surrounding_text(src_element)
+            if tgt_text != src_text:
+                print(f"{element!r}: {tgt_text!r} (input: {src_text!r})")
+
+        # Test whether the spaces around the elements are present. All spaces are
+        # treated as a single space (unless <pre></pre>) thus it doesn't need to
+        # be exactly the same. But space vs no space does affect the flow of the
+        # document.
+        print("Elements with differences in whitespace around tags")
+        for tgt_element in tgt_tree.iter():
+            n = tgt_element.get('x-test-id')
+            src_element = src_elements[n]
+            tgt_spaces = has_surrounding_spaces(tgt_element)
+            src_spaces = has_surrounding_spaces(src_element)
+            if tgt_spaces != src_spaces:
+                print(f"{format_whitespace(tgt_spaces)} (input: {format_whitespace(src_spaces)}) for {format_element(tgt_element)}")
+
+
+    compare_html(example, translate)

From 6049864bd8e88790bcb16a8453caa871646db206 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Sat, 19 Feb 2022 12:07:37 +0000
Subject: [PATCH 18/22] Apply black + isort

---
 bindings/python/tests/test_html.py | 60 +++++++++++++++---------------
 bindings/python/utils.py           | 27 +++++++-------
 2 files changed, 44 insertions(+), 43 deletions(-)

diff --git a/bindings/python/tests/test_html.py b/bindings/python/tests/test_html.py
index c60e4a655..0b6cb3ed9 100644
--- a/bindings/python/tests/test_html.py
+++ b/bindings/python/tests/test_html.py
@@ -1,9 +1,10 @@
 # type: ignore
-from bergamot import REPOSITORY, ResponseOptions, Service, ServiceConfig, VectorString
-import pytest
 from collections import Counter
 from string import whitespace
 
+import pytest
+from bergamot import REPOSITORY, ResponseOptions, Service, ServiceConfig, VectorString
+
 try:
     from lxml import etree, html
 except:
@@ -11,13 +12,13 @@
 
 
 def test_html():
-    MODEL = 'en-de-tiny'
-    config = ServiceConfig(numWorkers=4, logLevel='warn')
+    MODEL = "en-de-tiny"
+    config = ServiceConfig(numWorkers=4, logLevel="warn")
     service = Service(config)
-    config_path = REPOSITORY.modelConfigPath('browsermt', MODEL)
+    config_path = REPOSITORY.modelConfigPath("browsermt", MODEL)
     model = service.modelFromConfigPath(config_path)
 
-    example ="""
+    example = """
 <div class="wrap">
     <div class="image-wrap"><img src="/images/about.jpg" alt=""></div>
     <h2 id="the-bergamot-project">Das Projekt Bergamot</h2>
@@ -40,7 +41,11 @@ def get_surrounding_text(el):
         2 before_close: last_child.tail[-1] if last_child else elem.text[-1]
         3 after_close: elem.tail[0]
         """
-        before_open = el.getprevious().tail if el.getprevious() is not None else el.getparent().text
+        before_open = (
+            el.getprevious().tail
+            if el.getprevious() is not None
+            else el.getparent().text
+        )
         after_open = el.text
         last_child = next(el.iterchildren(reversed=True), None)
         before_close = last_child.tail if last_child is not None else el.text
@@ -49,8 +54,7 @@ def get_surrounding_text(el):
 
     def has_surrounding_text(el):
         return [
-            text is not None and text.strip() != ""
-            for text in get_surrounding_text(el)
+            text is not None and text.strip() != "" for text in get_surrounding_text(el)
         ]
 
     def has_surrounding_spaces(el):
@@ -59,41 +63,36 @@ def has_surrounding_spaces(el):
             for text, index in zip(get_surrounding_text(el), [-1, 0, -1, 0])
         ]
 
-
     def format_whitespace(slots):
-        return '{}<t>{}…{}</t>{}'.format(*[
-            '␣' if slot else '⊘'
-            for slot in slots
-        ])
+        return "{}<t>{}…{}</t>{}".format(*["␣" if slot else "⊘" for slot in slots])
 
     def format_element(el):
-        return '<{}{}>'.format(el.tag, ''.join(
-            f' {key}="{val}"'
-            for key, val in el.items()
-            if key != 'x-test-id'
-        ))
+        return "<{}{}>".format(
+            el.tag,
+            "".join(f' {key}="{val}"' for key, val in el.items() if key != "x-test-id"),
+        )
 
     def clean_html(src):
         tree = html.fromstring(src)
-        return html.tostring(tree, encoding='utf-8').decode()
+        return html.tostring(tree, encoding="utf-8").decode()
 
     def compare_html(src, translate):
         """Marks tags, then translates and compares translated HTML"""
         src_tree = html.fromstring(src)
-        src_elements = {
-            str(n): element for n, element in enumerate(src_tree.iter(), 1)
-        }
+        src_elements = {str(n): element for n, element in enumerate(src_tree.iter(), 1)}
         # Assign each element a unique id to help it correlate after translation
         for n, element in src_elements.items():
-            element.set('x-test-id', n)
-        src = html.tostring(src_tree, encoding='utf-8').decode()
+            element.set("x-test-id", n)
+        src = html.tostring(src_tree, encoding="utf-8").decode()
 
         tgt = translate(src)
         tgt_tree = html.fromstring(tgt)
 
         # Test if all elements are referenced once
         print("Elements referenced:")
-        tgt_element_count = Counter(element.get('x-test-id') for element in tgt_tree.iter())
+        tgt_element_count = Counter(
+            element.get("x-test-id") for element in tgt_tree.iter()
+        )
         for n, element in src_elements.items():
             count = tgt_element_count[n]
             if count != 1:
@@ -103,7 +102,7 @@ def compare_html(src, translate):
         # that should not be empty)
         print("Elements with missing text:")
         for tgt_element in tgt_tree.iter():
-            n = tgt_element.get('x-test-id')
+            n = tgt_element.get("x-test-id")
             src_element = src_elements[n]
             tgt_text = has_surrounding_text(tgt_element)
             src_text = has_surrounding_text(src_element)
@@ -116,12 +115,13 @@ def compare_html(src, translate):
         # document.
         print("Elements with differences in whitespace around tags")
         for tgt_element in tgt_tree.iter():
-            n = tgt_element.get('x-test-id')
+            n = tgt_element.get("x-test-id")
             src_element = src_elements[n]
             tgt_spaces = has_surrounding_spaces(tgt_element)
             src_spaces = has_surrounding_spaces(src_element)
             if tgt_spaces != src_spaces:
-                print(f"{format_whitespace(tgt_spaces)} (input: {format_whitespace(src_spaces)}) for {format_element(tgt_element)}")
-
+                print(
+                    f"{format_whitespace(tgt_spaces)} (input: {format_whitespace(src_spaces)}) for {format_element(tgt_element)}"
+                )
 
     compare_html(example, translate)
diff --git a/bindings/python/utils.py b/bindings/python/utils.py
index 1adc0f5ce..85e2735d6 100644
--- a/bindings/python/utils.py
+++ b/bindings/python/utils.py
@@ -1,11 +1,12 @@
+import json
 import os
+import typing as t
 
 import requests
 import yaml
-import json
-from ._bergamot import Response, AnnotatedText, Alignments
+
+from ._bergamot import Alignments, AnnotatedText, Response
 from .typing_utils import URL, PathLike
-import typing as t
 
 
 def download_resource(url: URL, save_location: PathLike, force_download=False):
@@ -64,14 +65,14 @@ def toPyNative(annotatedText: AnnotatedText) -> t.Dict[t.Any, t.Any]:
                 wordLs.append((word.begin, word.end))
             result.append(wordLs)
 
-        return {
-            "text": annotatedText.text,
-            "annotation": result
-        }
-
+        return {"text": annotatedText.text, "annotation": result}
 
-    return json.dumps({
-        "source": toPyNative(response.source),
-        "target": toPyNative(response.target),
-        "alignments": list(response.alignments)
-    }, *args, **kwargs)
+    return json.dumps(
+        {
+            "source": toPyNative(response.source),
+            "target": toPyNative(response.target),
+            "alignments": list(response.alignments),
+        },
+        *args,
+        **kwargs
+    )

From 51f42992bba2f6cb07593f6ec729c3b7de09d7ca Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Sat, 19 Feb 2022 12:11:13 +0000
Subject: [PATCH 19/22] Import from python wrapped bergamot to avoid pytype
 errors

---
 bindings/python/utils.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/bindings/python/utils.py b/bindings/python/utils.py
index 85e2735d6..0911cc3d1 100644
--- a/bindings/python/utils.py
+++ b/bindings/python/utils.py
@@ -5,7 +5,7 @@
 import requests
 import yaml
 
-from ._bergamot import Alignments, AnnotatedText, Response
+from . import Alignments, AnnotatedText, Response
 from .typing_utils import URL, PathLike
 
 

From fcee7d92c3b1f700cab8ba56d49ac5793e08a1af Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Sat, 19 Feb 2022 13:04:41 +0000
Subject: [PATCH 20/22] expand el -> element shorthand

---
 bindings/python/tests/test_html.py | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/bindings/python/tests/test_html.py b/bindings/python/tests/test_html.py
index 0b6cb3ed9..408ed34ac 100644
--- a/bindings/python/tests/test_html.py
+++ b/bindings/python/tests/test_html.py
@@ -33,7 +33,7 @@ def translate(src, HTML=True):
         responses = service.translate(model, VectorString([src]), options)
         return responses[0].target.text
 
-    def get_surrounding_text(el):
+    def get_surrounding_text(element):
         """
         Places for spaces: 0 <b> 1 … 2 </b> 3
         0 before_open: prev.tail[-1] if prev else parent.text[-1]
@@ -42,34 +42,34 @@ def get_surrounding_text(el):
         3 after_close: elem.tail[0]
         """
         before_open = (
-            el.getprevious().tail
-            if el.getprevious() is not None
-            else el.getparent().text
+            element.getprevious().tail
+            if element.getprevious() is not None
+            else element.getparent().text
         )
-        after_open = el.text
-        last_child = next(el.iterchildren(reversed=True), None)
-        before_close = last_child.tail if last_child is not None else el.text
-        after_close = el.tail
+        after_open = element.text
+        last_child = next(element.iterchildren(reversed=True), None)
+        before_close = last_child.tail if last_child is not None else element.text
+        after_close = element.tail
         return [before_open, after_open, before_close, after_close]
 
-    def has_surrounding_text(el):
+    def has_surrounding_text(element):
         return [
-            text is not None and text.strip() != "" for text in get_surrounding_text(el)
+            text is not None and text.strip() != "" for text in get_surrounding_text(element)
         ]
 
-    def has_surrounding_spaces(el):
+    def has_surrounding_spaces(element):
         return [
             isinstance(text, str) and len(text) > 0 and text[index] in whitespace
-            for text, index in zip(get_surrounding_text(el), [-1, 0, -1, 0])
+            for text, index in zip(get_surrounding_text(element), [-1, 0, -1, 0])
         ]
 
     def format_whitespace(slots):
         return "{}<t>{}…{}</t>{}".format(*["␣" if slot else "⊘" for slot in slots])
 
-    def format_element(el):
+    def format_element(element):
         return "<{}{}>".format(
-            el.tag,
-            "".join(f' {key}="{val}"' for key, val in el.items() if key != "x-test-id"),
+            element.tag,
+            "".join(f' {key}="{val}"' for key, val in element.items() if key != "x-test-id"),
         )
 
     def clean_html(src):

From 44f2f6c6f99007cdca5453b9164ef3e2e131e2e5 Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Sat, 19 Feb 2022 13:11:06 +0000
Subject: [PATCH 21/22] Apply black formatting again

---
 bindings/python/tests/test_html.py | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/bindings/python/tests/test_html.py b/bindings/python/tests/test_html.py
index 408ed34ac..a70bd828a 100644
--- a/bindings/python/tests/test_html.py
+++ b/bindings/python/tests/test_html.py
@@ -54,7 +54,8 @@ def get_surrounding_text(element):
 
     def has_surrounding_text(element):
         return [
-            text is not None and text.strip() != "" for text in get_surrounding_text(element)
+            text is not None and text.strip() != ""
+            for text in get_surrounding_text(element)
         ]
 
     def has_surrounding_spaces(element):
@@ -69,7 +70,9 @@ def format_whitespace(slots):
     def format_element(element):
         return "<{}{}>".format(
             element.tag,
-            "".join(f' {key}="{val}"' for key, val in element.items() if key != "x-test-id"),
+            "".join(
+                f' {key}="{val}"' for key, val in element.items() if key != "x-test-id"
+            ),
         )
 
     def clean_html(src):

From 22951175060a09b74e93ecdfa2c6ed7f9253d02d Mon Sep 17 00:00:00 2001
From: Jerin Philip <jerinphilip@live.in>
Date: Fri, 18 Mar 2022 20:22:49 +0000
Subject: [PATCH 22/22] Turn off qualityscores by default

---
 bindings/python/bergamot.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/bindings/python/bergamot.cpp b/bindings/python/bergamot.cpp
index 6b4d88ccd..be8d218df 100644
--- a/bindings/python/bergamot.cpp
+++ b/bindings/python/bergamot.cpp
@@ -186,7 +186,7 @@ PYBIND11_MODULE(_bergamot, m) {
           py::init<>([](bool qualityScores, bool alignment, bool HTML, bool sentenceMappings, ConcatStrategy strategy) {
             return ResponseOptions{qualityScores, alignment, HTML, sentenceMappings, strategy};
           }),
-          py::arg("qualityScores") = true, py::arg("alignment") = false, py::arg("HTML") = false,
+          py::arg("qualityScores") = false, py::arg("alignment") = false, py::arg("HTML") = false,
           py::arg("sentenceMappings") = true, py::arg("concatStrategy") = ConcatStrategy::FAITHFUL)
       .def_readwrite("qualityScores", &ResponseOptions::qualityScores)
       .def_readwrite("HTML", &ResponseOptions::HTML)