Metadata-Version: 2.1
Name: phpdoc-trans
Version: 0.0.3
Summary: PHP doc transaction tool
Home-page: https://github.com/AtlanticF/phpdoc-openai-trans
Author: meifeng.song
Author-email: atlanticfeng@icloud.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: openai
Requires-Dist: bs4
Requires-Dist: progress

# phpdoc-trans

A simple command line tool, use OpenAI api for phpdoc translation.


# Installation

`pip install phpdoc-trans`

# Use

You should have an openAPI key for this command.

To generate an openAI API key, while in the [openAI website](https://beta.openai.com), click on your username in the top right corner, then go to "View API keys" and create a key.

After you get the key, you should set environment variable OPENAI_API_KEY={YOUR_API_KEY}

```shell
phpdoc-trans --lang --model --max-tokens --temperature {translate file path}
```
You can use `phpdoc-trans --help` for more information
