| Name | academic-chatgpt JSON |
| Version |
0.4.1
JSON |
| download |
| home_page | |
| Summary | chatgpt for academic |
| upload_time | 2023-03-29 20:42:01 |
| maintainer | |
| docs_url | None |
| author | Yangyang Li |
| requires_python | >=3.9,<4.0 |
| license | GPLv3 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
# ChatGPT Academic Optimizer
[][pypi status]
[][pypi status]
[][pypi status]
[][license]
[][precommit]
[][black]
[](https://github.com/charliermarsh/ruff)
[pypi status]: https://pypi.org/project/academic-chatgpt/
[license]: https://opensource.org/licenses/GPLv3
[precommit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
</div>
A simple web interface for academic research and experimentation using GPT-3.5.
This is the forked version from [the project](https://github.com/binary-husky/chatgpt_academic)
**If you like this project, please give it a star. If you have come up with more useful academic shortcuts, feel free to open an issue or pull request.**
## Features
- Automatic paper abstract generation based on a provided LaTeX file
- Automatic code summarization and documentation generation
- C++ project header file analysis
- Python project analysis
- Self-code interpretation and dissection
- Experimental function template
<div align="center">
| Function | Description |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------ |
| One-click polishing | Supports one-click polishing and finding grammar errors in papers |
| One-click Chinese-English translation | One-click Chinese-English translation |
| One-click code interpretation | Can display code correctly and interpret code |
| Custom shortcut keys | Supports custom shortcut keys |
| Configure proxy server | Supports configuring proxy server |
| Modular design | Supports customizable high-order experimental functions |
| Self-program analysis | [Experimental feature] One-click to understand the source code of this project |
| Program analysis | [Experimental feature] One-click to analyze other Python/C++ projects |
| Reading papers | [Experimental feature] One-click to read the full text of a latex paper and generate an abstract |
| Batch comment generation | [Experimental feature] One-click to generate function comments in batches |
| chat analysis report generation | [Experimental feature] Automatically generates summary reports after running |
| Formula display | Can display the tex form and rendering form of the formula at the same time |
| Image display | Can display images in markdown |
| Supports markdown tables generated by GPT | Supports markdown tables generated by GPT |
</div>
- New interface
<div align="center">
<img src="https://cdn.jsdelivr.net/gh/cauliyang/blog-image@main//img/ui.png" width="700" >
</div>
- All buttons are dynamically generated by reading functional.py, and custom functions can be freely added to free the clipboard
<div align="center">
<img src="img/eq.gif" width="700" >
</div>
- Code display is also natural https://www.bilibili.com/video/BV1F24y147PD/
<div align="center">
<img src="img/polish.gif" width="700" >
</div>
- Supports markdown tables generated by GPT
<div align="center">
<img src="img/demo2.jpg" width="500" >
</div>
- If the output contains formulas, it will be displayed in both tex and rendering forms at the same time for easy copying and reading
<div align="center">
<img src="img/demo.jpg" width="500" >
</div>
- Too lazy to look at the project code? Just show off the chatgpt mouth
<div align="center">
<img src="https://user-images.githubusercontent.com/96192199/226935232-6b6a73ce-8900-4aee-93f9-733c7e6fef53.png" width="700" >
</div>
## Usage
### Prerequisites
- OpenAI API key (can be obtained from [here](https://beta.openai.com/signup/))
- Python 3.9 or higher
### Setup
```console
$pip install academic-chatgpt
```
### Run
1. Set your OpenAI API key and other configurations in `chataca.toml` or
`~/.config/chataca/chataca.toml`
The configuration file will locate at current working directory or `~/.config/chataca/`.
The example of `chataca.toml`
```toml
API_KEY = "sk-zH**********************************************"
API_URL = "https://api.openai.com/v1/chat/completions"
USE_PROXY = false
TIMEOUT_SECONDS = 30
WEB_PORT = 8080
MAX_RETRY = 3
LLM_MODEL = "gpt-3.5-turbo"
```
If you are in China, you need to set up an overseas agent to use the OpenAI API.
2. Start the server: `chataca`
### Experimental features
#### C++ project header file analysis
In the `project path` area, enter the project path and click on "[Experimental] Analyze entire C++ project (input the root directory of the project)
#### LaTeX project abstract generation
In the `project path` area, enter the project path and click on "[Experimental] Read LaTeX paper and write abstract (input the root directory of the project)
#### Python project analysis
In the `project path` area, enter the project path and click on "[Experimental] Analyze entire Python project (input the root directory of the project)"
Raw data
{
"_id": null,
"home_page": "",
"name": "academic-chatgpt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Yangyang Li",
"author_email": "yangyang.li@northwestern.edu",
"download_url": "https://files.pythonhosted.org/packages/26/7f/38131163eaad80a65c1efa8024e6126eae622eb1178e3d7afdd928498f3e/academic_chatgpt-0.4.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# ChatGPT Academic Optimizer\n\n[][pypi status]\n[][pypi status]\n[][pypi status]\n[][license]\n[][precommit]\n[][black]\n[](https://github.com/charliermarsh/ruff)\n\n[pypi status]: https://pypi.org/project/academic-chatgpt/\n[license]: https://opensource.org/licenses/GPLv3\n[precommit]: https://github.com/pre-commit/pre-commit\n[black]: https://github.com/psf/black\n\n</div>\n\nA simple web interface for academic research and experimentation using GPT-3.5.\n\nThis is the forked version from [the project](https://github.com/binary-husky/chatgpt_academic)\n\n**If you like this project, please give it a star. If you have come up with more useful academic shortcuts, feel free to open an issue or pull request.**\n\n## Features\n\n- Automatic paper abstract generation based on a provided LaTeX file\n- Automatic code summarization and documentation generation\n- C++ project header file analysis\n- Python project analysis\n- Self-code interpretation and dissection\n- Experimental function template\n\n<div align=\"center\">\n\n| Function | Description |\n| ----------------------------------------- | ------------------------------------------------------------------------------------------------ |\n| One-click polishing | Supports one-click polishing and finding grammar errors in papers |\n| One-click Chinese-English translation | One-click Chinese-English translation |\n| One-click code interpretation | Can display code correctly and interpret code |\n| Custom shortcut keys | Supports custom shortcut keys |\n| Configure proxy server | Supports configuring proxy server |\n| Modular design | Supports customizable high-order experimental functions |\n| Self-program analysis | [Experimental feature] One-click to understand the source code of this project |\n| Program analysis | [Experimental feature] One-click to analyze other Python/C++ projects |\n| Reading papers | [Experimental feature] One-click to read the full text of a latex paper and generate an abstract |\n| Batch comment generation | [Experimental feature] One-click to generate function comments in batches |\n| chat analysis report generation | [Experimental feature] Automatically generates summary reports after running |\n| Formula display | Can display the tex form and rendering form of the formula at the same time |\n| Image display | Can display images in markdown |\n| Supports markdown tables generated by GPT | Supports markdown tables generated by GPT |\n\n</div>\n\n- New interface\n<div align=\"center\">\n<img src=\"https://cdn.jsdelivr.net/gh/cauliyang/blog-image@main//img/ui.png\" width=\"700\" >\n</div>\n\n- All buttons are dynamically generated by reading functional.py, and custom functions can be freely added to free the clipboard\n<div align=\"center\">\n<img src=\"img/eq.gif\" width=\"700\" >\n</div>\n\n- Code display is also natural https://www.bilibili.com/video/BV1F24y147PD/\n<div align=\"center\">\n<img src=\"img/polish.gif\" width=\"700\" >\n</div>\n\n- Supports markdown tables generated by GPT\n<div align=\"center\">\n<img src=\"img/demo2.jpg\" width=\"500\" >\n</div>\n\n- If the output contains formulas, it will be displayed in both tex and rendering forms at the same time for easy copying and reading\n<div align=\"center\">\n<img src=\"img/demo.jpg\" width=\"500\" >\n</div>\n\n- Too lazy to look at the project code? Just show off the chatgpt mouth\n<div align=\"center\">\n<img src=\"https://user-images.githubusercontent.com/96192199/226935232-6b6a73ce-8900-4aee-93f9-733c7e6fef53.png\" width=\"700\" >\n</div>\n\n## Usage\n\n### Prerequisites\n\n- OpenAI API key (can be obtained from [here](https://beta.openai.com/signup/))\n- Python 3.9 or higher\n\n### Setup\n\n```console\n$pip install academic-chatgpt\n```\n\n### Run\n\n1. Set your OpenAI API key and other configurations in `chataca.toml` or\n `~/.config/chataca/chataca.toml`\n\nThe configuration file will locate at current working directory or `~/.config/chataca/`.\nThe example of `chataca.toml`\n\n```toml\nAPI_KEY = \"sk-zH**********************************************\"\nAPI_URL = \"https://api.openai.com/v1/chat/completions\"\nUSE_PROXY = false\nTIMEOUT_SECONDS = 30\nWEB_PORT = 8080\nMAX_RETRY = 3\nLLM_MODEL = \"gpt-3.5-turbo\"\n```\n\nIf you are in China, you need to set up an overseas agent to use the OpenAI API.\n\n2. Start the server: `chataca`\n\n### Experimental features\n\n#### C++ project header file analysis\n\nIn the `project path` area, enter the project path and click on \"[Experimental] Analyze entire C++ project (input the root directory of the project)\n\n#### LaTeX project abstract generation\n\nIn the `project path` area, enter the project path and click on \"[Experimental] Read LaTeX paper and write abstract (input the root directory of the project)\n\n#### Python project analysis\n\nIn the `project path` area, enter the project path and click on \"[Experimental] Analyze entire Python project (input the root directory of the project)\"\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "chatgpt for academic",
"version": "0.4.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "994b54c4a74e83954522c6da6e596369a612097c2c0ea658b67c8d3fcb6f3ab8",
"md5": "5eea2080f21ec2131786f66d1d9e88dc",
"sha256": "1c6f078f85b00b39c4834387acb89fc82f5dd4de13a4e5f3a2c7c0a06b8726f6"
},
"downloads": -1,
"filename": "academic_chatgpt-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5eea2080f21ec2131786f66d1d9e88dc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 36115,
"upload_time": "2023-03-29T20:41:59",
"upload_time_iso_8601": "2023-03-29T20:41:59.733266Z",
"url": "https://files.pythonhosted.org/packages/99/4b/54c4a74e83954522c6da6e596369a612097c2c0ea658b67c8d3fcb6f3ab8/academic_chatgpt-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "267f38131163eaad80a65c1efa8024e6126eae622eb1178e3d7afdd928498f3e",
"md5": "351334332b6b319f54c612c154aa4d7a",
"sha256": "3fae2875a19546903ca284b408c498a2b30090b24e20c8765f088fbb1b976fef"
},
"downloads": -1,
"filename": "academic_chatgpt-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "351334332b6b319f54c612c154aa4d7a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 31370,
"upload_time": "2023-03-29T20:42:01",
"upload_time_iso_8601": "2023-03-29T20:42:01.357919Z",
"url": "https://files.pythonhosted.org/packages/26/7f/38131163eaad80a65c1efa8024e6126eae622eb1178e3d7afdd928498f3e/academic_chatgpt-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-29 20:42:01",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "academic-chatgpt"
}
