Metadata-Version: 2.1
Name: co_op_translator
Version: 0.1.1
Summary: Easily automate multilingual translations for your projects with co-op-translator, powered by advanced LLM technology.
Home-page: https://github.com/Imperial-EE-Microsoft/microsoft_translation_public
License: MIT
Keywords: translator,translation,azure,openai,gpt
Author: Minseok Song
Author-email: skytin1004@gmail.com
Requires-Python: >=3.10,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: annotated-types (>=0.7.0,<0.8.0)
Requires-Dist: anyio (>=4.4.0,<5.0.0)
Requires-Dist: appnope (>=0.1.4,<0.2.0)
Requires-Dist: asttokens (>=2.4.1,<3.0.0)
Requires-Dist: azure-ai-vision-imageanalysis (>=1.0.0b2,<2.0.0)
Requires-Dist: azure-cognitiveservices-vision-computervision (>=0.9.0,<0.10.0)
Requires-Dist: azure-common (>=1.1.28,<2.0.0)
Requires-Dist: azure-core (>=1.30.2,<2.0.0)
Requires-Dist: certifi (>=2024.6.2,<2025.0.0)
Requires-Dist: charset-normalizer (>=3.3.2,<4.0.0)
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: comm (>=0.2.2,<0.3.0)
Requires-Dist: contourpy (>=1.2.1,<2.0.0)
Requires-Dist: cycler (>=0.12.1,<0.13.0)
Requires-Dist: decorator (>=5.1.1,<6.0.0)
Requires-Dist: distro (>=1.9.0,<2.0.0)
Requires-Dist: executing (>=2.0.1,<3.0.0)
Requires-Dist: fonttools (>=4.53.0,<5.0.0)
Requires-Dist: h11 (>=0.14.0,<0.15.0)
Requires-Dist: httpcore (>=1.0.5,<2.0.0)
Requires-Dist: httpx (>=0.27.0,<0.28.0)
Requires-Dist: idna (>=3.7,<4.0)
Requires-Dist: isodate (>=0.6.1,<0.7.0)
Requires-Dist: jedi (>=0.19.1,<0.20.0)
Requires-Dist: kiwisolver (>=1.4.5,<2.0.0)
Requires-Dist: matplotlib (>=3.9.0,<4.0.0)
Requires-Dist: matplotlib-inline (>=0.1.7,<0.2.0)
Requires-Dist: msrest (>=0.7.1,<0.8.0)
Requires-Dist: numpy (>=1.25.2,<2.0.0)
Requires-Dist: oauthlib (>=3.2.2,<4.0.0)
Requires-Dist: openai (>=1.33.0,<2.0.0)
Requires-Dist: opencv-python (>=4.10.0.82,<5.0.0.0)
Requires-Dist: packaging (>=24.1,<25.0)
Requires-Dist: parso (>=0.8.4,<0.9.0)
Requires-Dist: pexpect (>=4.9.0,<5.0.0)
Requires-Dist: pillow (>=10.3.0,<11.0.0)
Requires-Dist: platformdirs (>=4.2.2,<5.0.0)
Requires-Dist: prompt_toolkit (>=3.0.47,<4.0.0)
Requires-Dist: psutil (>=5.9.8,<6.0.0)
Requires-Dist: ptyprocess (>=0.7.0,<0.8.0)
Requires-Dist: pure-eval (>=0.2.2,<0.3.0)
Requires-Dist: pydantic (>=2.7.3,<3.0.0)
Requires-Dist: pydantic_core (>=2.18.4,<3.0.0)
Requires-Dist: pyparsing (>=3.1.2,<4.0.0)
Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
Requires-Dist: pyzmq (>=26.0.3,<27.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: requests-oauthlib (>=2.0.0,<3.0.0)
Requires-Dist: semantic_kernel (>=1.8.3,<2.0.0)
Requires-Dist: six (>=1.16.0,<2.0.0)
Requires-Dist: sniffio (>=1.3.1,<2.0.0)
Requires-Dist: stack-data (>=0.6.3,<0.7.0)
Requires-Dist: tiktoken (>=0.7.0,<0.8.0)
Requires-Dist: tornado (>=6.4.1,<7.0.0)
Requires-Dist: tqdm (>=4.66.4,<5.0.0)
Requires-Dist: traitlets (>=5.14.3,<6.0.0)
Requires-Dist: typing_extensions (>=4.12.2,<5.0.0)
Requires-Dist: urllib3 (>=2.2.1,<3.0.0)
Requires-Dist: wcwidth (>=0.2.13,<0.3.0)
Project-URL: Documentation, https://techcommunity.microsoft.com/t5/educator-developer-blog/localizing-github-repositories-with-llms/ba-p/4216434
Project-URL: Repository, https://github.com/Imperial-EE-Microsoft/microsoft_translation_public
Description-Content-Type: text/markdown

# translation_public

## Setting up the Development Environment

### Create a virtual environment

1. Type the following command inside your terminal to create a virtual environment named *venv*.

    ```console
    python -m venv venv
    ```

1. Type the following command inside your terminal to activate the virtual environment.

    for Windows

    ```console
    venv\Scripts\activate.bat
    ```

    for Mac / Linux

    ```console
    source venv/bin/activate
    ```

> [!NOTE]
>
> If it worked, you should see *(venv)* before the command prompt.
> Remember to activate the virtual environment every time you work on the project by running from the repository's root directory.

### Install the required packages

1. Type the following commands inside your terminal to install the required packages.

    ```console
    pip install -r requirements.txt
    ```

### Add environment variables

1. Create an `.env` file in the root directory of your project by copying the provided .env.template file. Fill in the environment variables in the `.env` file as a guide.

1. The environment variables will be automatically loaded when you run any script that imports and executes `base.py` from the `src/config` directory.

### Install the package in editable mode

1. Type the following command inside your terminal to install the package in editable mode:

    ```console
    pip install -e .
    ```

## Running Tests

1. To run tests, make sure your virtual environment is activated, then type the following command:

    ```console
    pytest tests/
    ```

## Sample notebooks

- [Getting Started with notebook: basic version](notebooks/notebook_for_microsoft_final.ipynb)
- [Getting Started with notebook: module version](notebooks/notebook_for_module_project.ipynb)

