Publish to Hugging Face space

.dockerignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+.venv/
+Pipfile
+Pipfile.lock
+*.pyc
+*.pyo
+*.pyd
+*.egg-info/
+dist/
+build/
+.idea/
+.DS_Store
+.git/

.gitattributes

@@ -0,0 +1,35 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

.github/workflows/ci-cd.yaml

@@ -0,0 +1,142 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+---
+name: CI/CD
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+env:
+  PYTHON_VERSION: "3.10"
+
+jobs:
+  cancel-previous:
+    name: Cancel Previous Runs In Order to Allocate Action Resources Immediately for Current Run
+    if: github.ref != 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel previous
+        uses: styfle/cancel-workflow-action@0.10.1
+        with:
+          access_token: ${{ github.token }}
+
+  yaml-lint:
+    name: YAML Style Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actionshub/yamllint@main
+
+  markdown-lint:
+    name: Markdown Style Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actionshub/markdownlint@main
+
+  linkChecker:
+    name: Link Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@v1.9.0
+        with:
+          fail: true
+
+  integration-tests:
+    name: Integration Tests
+    needs: [yaml-lint, markdown-lint, linkChecker]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - run: pip3 install -r requirements.txt
+      - name: Start app
+        run: python3 app.py &
+      - name: Wait for app to be ready
+        uses: iFaxity/wait-on-action@v1
+        with:
+          resource: http://localhost:7860
+      - name: Verify API endpoint is working
+        uses: iFaxity/wait-on-action@v1
+        with:
+          resource: http://localhost:7860/?view=api
+          timeout: 60000
+
+  docker:
+    name: Test Docker Image & Container and Publish Image to Docker Hub
+    needs: [yaml-lint, markdown-lint, linkChecker]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Image Build Test
+        run: docker build -t jack20191124/aristotle .
+      - name: Startup a Container
+        run: docker run -d --name aristotle -p 7860:7860 -e SERVER_NAME=0.0.0.0 jack20191124/aristotle
+      - name: Wait for container to be up and running
+        uses: iFaxity/wait-on-action@v1
+        with:
+          resource: http://localhost:7860
+      - name: Verify API endpoint is working
+        uses: iFaxity/wait-on-action@v1
+        with:
+          resource: http://localhost:7860/?view=api
+          timeout: 60000
+      - name: Login to DockerHub
+        if: github.ref == 'refs/heads/master'
+        uses: docker/login-action@v2
+        with:
+          username: jack20191124
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Push image to DockerHub
+        if: github.ref == 'refs/heads/master'
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          tags: jack20191124/aristotle:latest
+      - name: Push image Description
+        if: github.ref == 'refs/heads/master'
+        uses: peter-evans/dockerhub-description@v4
+        with:
+          username: jack20191124
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: jack20191124/aristotle
+          readme-filepath: README.md
+
+  sync-to-huggingface-space:
+    needs: [integration-tests]
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          lfs: true
+      - name: Push to hub
+        run: git push https://QubitPi:$HF_TOKEN@huggingface.co/spaces/QubitPi/aristotle master:main -f
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}

.gitignore

@@ -1 +1,5 @@
-.idea/
+.idea
+.env
+venv
+__pycache__
+docker-compose.yml

.lycheeignore

@@ -0,0 +1 @@
+http://localhost:7860

.mdlrc

@@ -0,0 +1,2 @@
+rules "~MD002", "~MD003", "~MD005", "~MD007", "~MD013", "~MD022", "~MD024", "~MD027", "~MD028", "~MD029", "~MD033", "~MD034", "~MD036", "~MD041", "~MD055", "~MD057"
+style "#{File.dirname(__FILE__)}/markdownlint.rb"

.yamllint

@@ -0,0 +1,23 @@
+---
+extends: default
+rules:
+  line-length:
+    max: 256
+    level: warning
+  document-start: disable
+  braces:
+    forbid: false
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  commas:
+    max-spaces-before: -1
+    min-spaces-after: 1
+    max-spaces-after: -1
+  brackets:
+    max-spaces-inside: -1
+  empty-lines:
+    max: 3
+  indentation:
+    spaces: 2

Dockerfile

@@ -0,0 +1,22 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM python:3.10-slim
+
+WORKDIR /usr/src/app
+COPY . .
+RUN pip install -r requirements.txt
+EXPOSE 7860
+
+CMD ["python", "app.py"]

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Jiaqi Liu
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,11 +1,47 @@
-Ancient Greek Reader NLP
-========================
+---
+title: Aristotle
+emoji: 🏆
+colorFrom: gray
+colorTo: green
+sdk: gradio
+sdk_version: 5.1.0
+app_file: app.py
+pinned: false
+license: apache-2.0
+short_description: Ancient Greek text to audio
+---
 
-__A lack of audio content is a major hurdle to learning Ancient Greek__. So I decided to tackle this problem with NLP.
+Aristotle
+=========
+
+![Python Version Badge]
+[![Hugging Face space badge]][Hugging Face space URL]
+[![GitHub workflow status badge][GitHub workflow status badge]][GitHub workflow status URL]
+[![Hugging Face sync status badge]][Hugging Face sync status URL]
+[![Docker Hub][Docker Pulls Badge]][Docker Hub URL]
+[![Apache License Badge]][Apache License, Version 2.0]
+
+__Aristotle__ is an automatic text to speech application that takes an Ancient Greek excerpt as input and generates a
+downloadable audio for language learner for practice speaking in Ancient Greek. Aristotle generates speech using the
+[OpenAI's text-to-speech API](https://platform.openai.com/docs/guides/text-to-speech).
+
+The app is available on [Hugging Face space][Project Aristotle on Hugging Face]. Please check it out.
+
+A Docker image is also available:
+
+```console
+docker run -d --name aristotle -p 7860:7860 jack20191124/aristotle
+```
+
+When container is up and running, visit app at  [http://localhost:7860](http://localhost:7860).
 
 How Does It Work
 ----------------
 
+Ancient Greek is a phonetically-lost language, because no one knows the correct pronunciation of such an ancient
+language. __A lack of audio content is a major hurdle to learning Ancient Greek__. So I decided to tackle this problem
+with NLP.
+
 OpenAI will read Ancient Greek text with a modern Greek pronunciation. What's different about OpenAI from other
 Text-to-Speech tools is that OpenAI is unaffected by the different accents and breathing marks in Ancient Greek. It will
 simply read the Ancient Greek text in modern pronunciation with the accents in the right places. Studying Ancient Greeek
@@ -28,22 +64,76 @@ And here is the same but with letters replaced to try and get OpenAI to read in
 A huge list of [letter replacements](./ancient-greek-phonemes.txt) has been made to try and imitate Attic pronunciation
 as closely as possible. The result is pretty solid and is close enough to be useful for creating audio files for texts
 where we don't have any audio recordings.
-[Checkout this "Attic" pronounciation example](https://qubitpi.github.io/ancient-greek-reader/)
 
-How to Use It (WIP)
--------------------
+Development
+-----------
+
+### Running Locally
+
+```console
+git clone git@github.com:QubitPi/aristotle.git
+cd aristotle
+
+virtualenv .venv
+source .venv/bin/activate
+pip3 install -r requirements.txt
+```
+
+To start the app:
+
+```console
+export SERVER_NAME=127.0.0.1
+python3 app.py
+```
+
+The app will be available at [http://localhost:7860](http://localhost:7860) and the API docs at
+[http://localhost:7860/?view=api](http://localhost:7860/?view=api)
+
+### Docker
+
+To build a Docker container of Aristotle, follow these steps:
+
+1. Make sure Docker has been installed
+2. Open a terminal and navigate to the project directory.
+3. Run the following command to build the Docker image:
+
+    ```consule
+    docker build -t jack20191124/aristotle .
+    ```
+
+4. Wait for the build process to complete.
+5. Once the build is finished, we can run the Docker container using the following command:
+
+    ```console
+    docker run -it --name aristotle -p 7860:7860 jack20191124/aristotle
+    ```
+
+6. Open up browser and navigate to [http://localhost:7860](http://localhost:7860) to access the space.
+
+### Toubleshooting
+
+#### `No matching distribution found for fastapi` While Executing `pip3 install -r requirements.txt`
+
+This could be caused by one's proxy. Simply turn-off or switch proxy should work
+
+License
+-------
+
+The use and distribution terms for [aristotle]() are covered by the [Apache License, Version 2.0].
 
-Here is a __WIP__ instruction: 
+[Apache License Badge]: https://img.shields.io/badge/Apache%202.0-F25910.svg?style=for-the-badge&logo=Apache&logoColor=white
+[Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
 
-1. Get an accurate Ancient Greek text and save it to a file named __original.txt__.
-   [Perseus Digital Library](https://www.perseus.tufts.edu/hopper/) is a great source.
-2. Run replacement:
+[Docker Pulls Badge]: https://img.shields.io/docker/pulls/jack20191124/aristotle?style=for-the-badge&logo=docker&color=2596EC
+[Docker Hub URL]: https://hub.docker.com/r/jack20191124/aristotle
 
-   - `python3 convert.py`
+[GitHub workflow status badge]: https://img.shields.io/github/actions/workflow/status/QubitPi/wilhelm/ci-cd.yaml?branch=master&style=for-the-badge&logo=github&logoColor=white&label=CI/CD
+[GitHub workflow status URL]: https://github.com/QubitPi/wilhelm/actions/workflows/ci-cd.yaml
 
-3. Convert txt to epub. [Calibre](https://calibre-ebook.com/) works pretty well for this.
-4. Use https://github.com/p0n1/epub_to_audiobook to generate audio
+[Hugging Face space badge]: https://img.shields.io/badge/Hugging%20Face%20Space-aristotle-FFD21E?style=for-the-badge&logo=huggingface&logoColor=white
+[Hugging Face space URL]: https://huggingface.co/spaces/QubitPi/aristotle
+[Hugging Face sync status badge]: https://img.shields.io/github/actions/workflow/status/QubitPi/aristotle/ci-cd.yaml?branch=master&style=for-the-badge&logo=github&logoColor=white&label=Hugging%20Face%20Sync%20Up
+[Hugging Face sync status URL]: https://github.com/QubitPi/aristotle/actions/workflows/ci-cd.yaml
 
-> [!CAUTION]
->
-> OpenAI [billing](https://platform.openai.com/settings/organization/billing/overview) will apply to the last step
+[Project Aristotle on Hugging Face]: https://huggingface.co/spaces/QubitPi/aristotle
+[Python Version Badge]: https://img.shields.io/badge/Python-3.10-FFD845?labelColor=498ABC&style=for-the-badge&logo=python&logoColor=white

app.py

@@ -0,0 +1,99 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import os
+import tempfile
+from typing import Literal
+from typing import Union
+
+import gradio as gr
+from openai import OpenAI
+
+server_name = os.getenv("SERVER_NAME", "0.0.0.0")
+
+def latin_replacement(text: str):
+    with open("ancient-greek-phonemes.txt", "r") as mapping_file:
+        mapping = dict(
+            [(ancient_greek, latin) for ancient_greek, latin in
+             [line.rstrip().split("->") for line in mapping_file.readlines()]]
+        )
+    for key, value in mapping.items():
+        text = text.replace(key, value)
+
+    return text
+
+
+def tts(
+        openai_key: str,
+        text: str,
+        model: Union[str, Literal["tts-1", "tts-1-hd"]],
+        voice: Literal["alloy", "echo", "fable", "onyx", "nova", "shimmer"],
+        output_file_format: Literal["mp3", "opus", "aac", "flac"] = "mp3",
+        speed: float = 1.0
+):
+    if len(text) > 0:
+        text = latin_replacement(text)
+
+        try:
+            client = OpenAI(api_key=openai_key)
+
+            response = client.audio.speech.create(
+                model=model,
+                voice=voice,
+                input=text,
+                response_format=output_file_format,
+                speed=speed
+            )
+
+        except Exception as error:
+            print(str(error))
+            raise gr.Error(
+                "An error occurred while generating speech. Please check your API key and come back try again.")
+
+        with tempfile.NamedTemporaryFile(suffix=".mp3", delete=False) as temp_file:
+            temp_file.write(response.content)
+
+        temp_file_path = temp_file.name
+
+        return temp_file_path
+    else:
+        return "1-second-of-silence.mp3"
+
+
+with gr.Blocks() as app:
+    gr.Markdown("# <center> AI Doesn't Speak Ancient Greek. Aristotle Does! </center>")
+    with gr.Row(variant="panel"):
+        model = gr.Dropdown(choices=["tts-1", "tts-1-hd"], label="Model", value="tts-1")
+        voice = gr.Dropdown(choices=["alloy", "echo", "fable", "onyx", "nova", "shimmer"], label="Voice Options",
+                            value="alloy")
+        output_file_format = gr.Dropdown(choices=["mp3", "opus", "aac", "flac"], label="Output Options", value="mp3")
+        speed = gr.Slider(minimum=0.25, maximum=4.0, value=1.0, step=0.01, label="Speed")
+
+    openai_key = gr.Textbox(
+        label="OpenAI API key",
+        placeholder="We can get the key at https://platform.openai.com/api-keys"
+    )
+    text = gr.Textbox(
+        label="Ancient Greek text",
+        placeholder="Enter your text and then click on the \"Text-To-Speech\" button, or simply press the Enter key."
+    )
+    examples = gr.Examples([[" Ὁμώνυμα λέγεται ὧν ὄνομα μόνον κοινόν"]], text)
+    btn = gr.Button("Hear It!")
+    output_audio = gr.Audio(label="Speech Output")
+
+    text.submit(fn=tts, inputs=[openai_key, text, model, voice, output_file_format, speed], outputs=output_audio,
+                api_name="tts")
+    btn.click(fn=tts, inputs=[openai_key, text, model, voice, output_file_format, speed], outputs=output_audio,
+              api_name=False)
+
+app.launch(server_name=server_name)

convert.py

@@ -1,13 +0,0 @@
-if __name__ == "__main__":
-    with open("ancient-greek-phonemes.txt", "r") as mapping_file:
-        mapping = dict(
-            [(ancient_greek, latin) for ancient_greek, latin in [line.rstrip().split("->") for line in mapping_file.readlines()]]
-        )
-    with open("original.txt", "r") as book_txt:
-        book = book_txt.read()
-
-    for key, value in mapping.items():
-        book = book.replace(key, value)
-
-    with open("converted.txt", "w") as book_txt:
-        book_txt.write(book)

markdownlint.rb

@@ -0,0 +1,20 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+all
+rule 'MD003', style: :setext_with_atx
+rule 'MD004', style: :sublist
+rule 'MD013', line_length: 120
+rule 'MD029', style: :ordered
+rule 'MD026', punctuation: ".,;:!?"

requirements.txt

@@ -0,0 +1,3 @@
+gradio~=4.12.0
+openai~=1.2.3
+fastapi==0.112.2