RE:KAI

Rekai is in the pre-release state and a lot of stuff is still broken and dysfunctional. So please use at your own descretion.

A more detailed Readme will come soon.

Acknowledgements:

"If I have seen further, it is by standing on the shoulders of giants." - Sir Issac Newton

This is a side project that I took up on my journey learning to code. And it wouldn't have been possible without the vast number of beautifully written dependances that it's built upon. The open source community is awesome and I'm tremendously grateful to all those who have contibuted to those dependencies.

I'm also indebted to Bikatr7, the author of Kudasai - A Japanese-English preprocessor with automated translation capabilities, for it's "Kairyou" preprocessing package which has been incorporated into Rekai, and their contributions to this project; and to kroatoanjp, the author of Fukuin, another preprocessing script that has been refactored and incorporated into Rekai.

I'm also tremendously greatful to JanSnoh for reviewing the codebase and all the great advice and contributions along the way.

Setting up Rekai

Certainly! Here's the modified set of instructions in Markdown format for downloading, installing, and running a Python script from a GitHub repository:

Download and Running for the First Time:

Follow these steps to download, install, and run the Python script from a GitHub repository:

Step 1: Clone\Download the Repository

Once you have git installed and running:

1. Open your terminal or command prompt.

2. Navigate to the directory where you want to clone the repository.

3. Run the following command to clone the repository:

   git clone https://github.com/trulybeloved/Rekai.git

Step 2: Install Dependencies

1. Ensure you have Python installed. If not, download and install Python from python.org.

   • Rekai has been tested on Python 3.11 and higher

2. Navigate to the directory containing the cloned repository using the terminal.

3. Run the following command to install dependencies (if any):

   pip install -r requirements.txt

Step 3: Run the Script

1. In the terminal, navigate to the directory containing the cloned repository.

2. Execute the script using the following command:

   python rekai_main.py

   or

   python3 rekai_main.py

3. If everything went well, then you should have the webgui open up in your default browser. If not, click on the URL that is generated within the terminal/console window.

The above method is only assured to work if you've never really installed any other dependances to your core python enviroment. It is recommended to use a seperate VENV for Rekai. If you are unfamilar with that, read this guide.

Setting up API access:

This project uses the following APIs:

• DeepL:

  • DeepL API Documentation

• Google Cloud Text-to-Speech:

  • Google Cloud Text-to-Speech Documentation

• Google Cloud Translation:

  • Google Cloud Translation API Documentation

IMPORTANT: API Costs

As you are required to use your own API Keys/Authentication, please be aware of the potential risks of generating unintended requests due to programming errors. Kindly take appropriate measures to set up quotas/limitations in the respective API provider consoles/settings.

The APIs implemented offer generous free quotas per month and should suffice for personal use.

Service	Monthly Free Quota
Deepl FREE	500,000 characters/mo
GCloud TL	500,000 characters/mo
GCloud TTS	WaveNet voices - 4,000,000 characters/mo
	Neural2 voices - up to 1,000,000 bytes/mo

(These values are subject to change. Kindly confirm from official documentation)

Obtaining DeepL API:

Subscribe to DeepL here. The free API does need a valid credit card. Deepl should also be providing it's API sevice in your region.

The authentication is using an API key and will need to be provided while using Rekai. You can generate/find this in your account page at Deepl.com

Setting up Google Cloud APIs:

This project leverages Google Cloud services and requires authentication using the Google Cloud CLI. Follow the steps below to set up authentication and configure your Google Cloud project. Google's Translation API library for python does not support API keys. Hence installation of the SDK is necessary for providing Google Translate functionality.

Prerequisites

Before you begin, make sure you have the following:

• Google Cloud Account (requires a valid credit card/payment method)
• Google Cloud SDK installed.
• A Google Cloud project created.
  • This project should have the relevant APIs enabled in the Google Cloud Dashboard.

Setup Instructions

1. Install and Initialize Google Cloud SDK

If you haven't installed the Google Cloud SDK, follow the instructions here.

Initialize Gooogle Cloud SDK by following the instructions here

2. Authenticate with Google Cloud

Run the following command in a terminal application to authenticate with Google Cloud:

gcloud auth login

This will open a browser window prompting you to log in with your Google Cloud credentials.

3. Set Default Project

After successful authentication, set your default project using the following command:

gcloud config set project YOUR_PROJECT_ID

Replace YOUR_PROJECT_ID with the actual ID of your Google Cloud project.

4. Verify Configuration

To verify that your configuration is set up correctly, run:

gcloud config list

Make sure that the project property is set to your project ID.

5. Set up Application Default Credentials

This is applicatble if you are running Rekai in a local environment, like your own personal computer.

Read more about it here

Create the credential file by running:

gcloud auth application-default login

This may once again open a browser window prompting you to log in with your Google Cloud credentials.

6. Done.

You should now be able to use Google Cloud APIs within Rekai.

Troubleshooting

If you encounter any issues during the setup process, refer to the Google Cloud SDK documentation for troubleshooting tips.