# 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/Imperial-EE-Microsoft/microsoft_translation_public",
"name": "co_op_translator",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "translator, translation, azure, openai, gpt",
"author": "Minseok Song",
"author_email": "skytin1004@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e4/4b/8271e9bea86cf085c9bca17c2c8a8b11402ab98de4fc524de0b0b3071c06/co_op_translator-0.1.4.tar.gz",
"platform": null,
"description": "# translation_public\n\n## Setting up the Development Environment\n\n### Create a virtual environment\n\n1. Type the following command inside your terminal to create a virtual environment named *venv*.\n\n ```console\n python -m venv venv\n ```\n\n1. Type the following command inside your terminal to activate the virtual environment.\n\n for Windows\n\n ```console\n venv\\Scripts\\activate.bat\n ```\n\n for Mac / Linux\n\n ```console\n source venv/bin/activate\n ```\n\n> [!NOTE]\n>\n> If it worked, you should see *(venv)* before the command prompt.\n> Remember to activate the virtual environment every time you work on the project by running from the repository's root directory.\n\n### Install the required packages\n\n1. Type the following commands inside your terminal to install the required packages.\n\n ```console\n pip install -r requirements.txt\n ```\n\n### Add environment variables\n\n1. 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.\n\n1. The environment variables will be automatically loaded when you run any script that imports and executes `base.py` from the `src/config` directory.\n\n### Install the package in editable mode\n\n1. Type the following command inside your terminal to install the package in editable mode:\n\n ```console\n pip install -e .\n ```\n\n## Running Tests\n\n1. To run tests, make sure your virtual environment is activated, then type the following command:\n\n ```console\n pytest tests/\n ```\n\n## Sample notebooks\n\n- [Getting Started with notebook: basic version](notebooks/notebook_for_microsoft_final.ipynb)\n- [Getting Started with notebook: module version](notebooks/notebook_for_module_project.ipynb)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Easily automate multilingual translations for your projects with co-op-translator, powered by advanced LLM technology.",
"version": "0.1.4",
"project_urls": {
"Documentation": "https://techcommunity.microsoft.com/t5/educator-developer-blog/localizing-github-repositories-with-llms/ba-p/4216434",
"Homepage": "https://github.com/Imperial-EE-Microsoft/microsoft_translation_public",
"Repository": "https://github.com/Imperial-EE-Microsoft/microsoft_translation_public"
},
"split_keywords": [
"translator",
" translation",
" azure",
" openai",
" gpt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "34b2ee0aecd7fbb06f0c7a27d24cdcce980e112d185b671e63d87f3be6911502",
"md5": "15f757a14e5f3680e6ca87a62a58da88",
"sha256": "1923472dc8b13419e8efb4ef04133db2bbb69b8153f3d32dcca1d8f8e52cc997"
},
"downloads": -1,
"filename": "co_op_translator-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15f757a14e5f3680e6ca87a62a58da88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 15638445,
"upload_time": "2024-09-12T16:08:17",
"upload_time_iso_8601": "2024-09-12T16:08:17.763591Z",
"url": "https://files.pythonhosted.org/packages/34/b2/ee0aecd7fbb06f0c7a27d24cdcce980e112d185b671e63d87f3be6911502/co_op_translator-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e44b8271e9bea86cf085c9bca17c2c8a8b11402ab98de4fc524de0b0b3071c06",
"md5": "3526b487002e269fecc81dbdc63764bc",
"sha256": "89411f3d3658cf30aa5fbd81454497f60258564862ba2da97c466248c76d2680"
},
"downloads": -1,
"filename": "co_op_translator-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "3526b487002e269fecc81dbdc63764bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 15626874,
"upload_time": "2024-09-12T16:09:03",
"upload_time_iso_8601": "2024-09-12T16:09:03.463179Z",
"url": "https://files.pythonhosted.org/packages/e4/4b/8271e9bea86cf085c9bca17c2c8a8b11402ab98de4fc524de0b0b3071c06/co_op_translator-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-12 16:09:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Imperial-EE-Microsoft",
"github_project": "microsoft_translation_public",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "co_op_translator"
}
JSON
