# ChatResearch
[][pypi status]
[][pypi status]
[][license]
[][precommit]
[][black]
[](https://github.com/charliermarsh/ruff)
ChatResearch is a tool that uses OpenAI's GPT-3 to accelerate your research.
It provides several features such as generating summary papers, fetching and summarizing papers from arxiv and bioarxiv, generating responses for review comments, and more.
## :question: Why ChatResearch
There have been countless projects and research initiatives in the field of ChatGPT,
but none have fulfilled my particular needs.
Consequently, I have made the decision to develop my own project.
I am committed to continuously refining and improving this project.
Your support and ratings are greatly appreciated, so please do not hesitate to leave a star.
I also welcome any suggestions, proposals, and pull requests.
## :rocket: News
- Multi thread and Asynchronous support has been added.
- GIFs have been added for documentation.
- Config can now be used to set key.
- Output for Latex and PDF is now supported.
## :bookmark: TODO
- [x] Multi thread and Asynchronous support
- [x] Add GIF for document
- [x] Use config to set key
- [x] Support output for Latex and PDF
- [ ] Fine-tune prompt
- [ ] Generate Image
- [ ] Add RSS support for multiple journal
- [ ] Revise help message
- [ ] add classic paper as examples
## :star2: Features
- [Chat Config](#chat-config): Generate `chatre.toml` in current working directory or set environment variable `OPENAI_API_KEY`.
- [Chat Paper](#chat-paper): Fetch or summary paper from local or arxiv with specified query, research fields, and language.
- [Chat Biorxiv](#chat-biorxiv): Fetch and summary paper from bioarxiv with specified category, filter keys, and language.
- [Chat Reviewer](#chat-reviewer): Generate summary paper with specified research fields and language.
- [Chat Response](#chat-response): Generate response for review comment with specified language.
- [Markdown](https://github.com/cauliyang/ChatResearch/blob/main/docs/examples/example2.md), [PDF](https://github.com/cauliyang/ChatResearch/blob/main/docs/examples/example1.pdf), and [Latex](https://github.com/cauliyang/ChatResearch/blob/main/docs/examples/example5.tex)
## :gear: Installation
```console
pip install chat-research
```
## :face_with_monocle: Usage
<img src="https://github.com/cauliyang/ChatResearch/blob/main//docs/tutorial/help.gif" width="800" height="400">
### Chat Config
<img src="https://github.com/cauliyang/ChatResearch/blob/main//docs/tutorial/config.gif" width="800" height="400">
```console
❯ chatre config
```
It will generate `chatre.toml` in current working directory. Otherwise,
setting environment variable `OPENAI_API_KEY` is another way to config API KEY.
Also, `chatre config set OPENAI_API_KEY=sk-key` will create configuration file
in current file directory and set your key as `sk-key`.
```toml
[OpenAI]
OPENAI_API_KEYS = [ "sk-key1", "sk-key2",]
[Gitee]
api = "your_gitee_api"
owner = "your_gitee_name"
repo = "your_repo_name"
path = "files_name_in_your_repo"
```
### Chat Paper
<img src="https://github.com/cauliyang/ChatResearch/blob/main//docs/tutorial/paper.gif" width="800" height="400">
### Chat Biorxiv
<img src="https://github.com/cauliyang/ChatResearch/blob/main//docs/tutorial/biorxiv.gif" width="800" height="400">
### Chat Response
<img src="https://github.com/cauliyang/ChatResearch/blob/main//docs/tutorial/response.gif" width="800" height="400">
### Chat Reviewer
```console
> chatre reviewer -h
usage: chatre reviewer [-h] --paper-path [--file-format] [--review-format] [--research-fields] [--language]
optional arguments:
-h, --help show this help message and exit
--paper-path path of papers
--file-format output file format (default: txt)
--review-format review format
--research-fields the research fields of paper (default: computer science, artificial intelligence and reinforcement learning)
--language output language, en or zh (default: en)
```
## :facepunch: Develop Toolkit
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributors
- Yangyang Li
## :clap: Acknowledgement
- [ChatPaper](https://github.com/kaixindelele/ChatPaper/blob/main/README.md)
- [Arxiv](https://github.com/lukasschwab/arxiv.py)
<!-- links -->
[black]: https://github.com/psf/black
[license]: https://opensource.org/licenses/mit
[precommit]: https://github.com/pre-commit/pre-commit
[pypi status]: https://pypi.org/project/chat-research
Raw data
{
"_id": null,
"home_page": "https://github.com/cauliyang/ChatResearch",
"name": "chat-research",
"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/3a/41/7f716f883271b5aeeab925358b9b639dc95cad7154d388b4f44335752a36/chat_research-0.1.13.tar.gz",
"platform": null,
"description": "# ChatResearch\n\n[][pypi status]\n[][pypi status]\n[][license]\n[][precommit]\n[][black]\n[](https://github.com/charliermarsh/ruff)\n\nChatResearch is a tool that uses OpenAI's GPT-3 to accelerate your research.\nIt provides several features such as generating summary papers, fetching and summarizing papers from arxiv and bioarxiv, generating responses for review comments, and more.\n\n## :question: Why ChatResearch\n\nThere have been countless projects and research initiatives in the field of ChatGPT,\nbut none have fulfilled my particular needs.\nConsequently, I have made the decision to develop my own project.\nI am committed to continuously refining and improving this project.\nYour support and ratings are greatly appreciated, so please do not hesitate to leave a star.\nI also welcome any suggestions, proposals, and pull requests.\n\n## :rocket: News\n\n- Multi thread and Asynchronous support has been added.\n- GIFs have been added for documentation.\n- Config can now be used to set key.\n- Output for Latex and PDF is now supported.\n\n## :bookmark: TODO\n\n- [x] Multi thread and Asynchronous support\n- [x] Add GIF for document\n- [x] Use config to set key\n- [x] Support output for Latex and PDF\n- [ ] Fine-tune prompt\n- [ ] Generate Image\n- [ ] Add RSS support for multiple journal\n- [ ] Revise help message\n- [ ] add classic paper as examples\n\n## :star2: Features\n\n- [Chat Config](#chat-config): Generate `chatre.toml` in current working directory or set environment variable `OPENAI_API_KEY`.\n- [Chat Paper](#chat-paper): Fetch or summary paper from local or arxiv with specified query, research fields, and language.\n- [Chat Biorxiv](#chat-biorxiv): Fetch and summary paper from bioarxiv with specified category, filter keys, and language.\n- [Chat Reviewer](#chat-reviewer): Generate summary paper with specified research fields and language.\n- [Chat Response](#chat-response): Generate response for review comment with specified language.\n- [Markdown](https://github.com/cauliyang/ChatResearch/blob/main/docs/examples/example2.md), [PDF](https://github.com/cauliyang/ChatResearch/blob/main/docs/examples/example1.pdf), and [Latex](https://github.com/cauliyang/ChatResearch/blob/main/docs/examples/example5.tex)\n\n## :gear: Installation\n\n```console\npip install chat-research\n```\n\n## :face_with_monocle: Usage\n\n<img src=\"https://github.com/cauliyang/ChatResearch/blob/main//docs/tutorial/help.gif\" width=\"800\" height=\"400\">\n\n### Chat Config\n\n<img src=\"https://github.com/cauliyang/ChatResearch/blob/main//docs/tutorial/config.gif\" width=\"800\" height=\"400\">\n\n```console\n\u276f chatre config\n```\n\nIt will generate `chatre.toml` in current working directory. Otherwise,\nsetting environment variable `OPENAI_API_KEY` is another way to config API KEY.\nAlso, `chatre config set OPENAI_API_KEY=sk-key` will create configuration file\nin current file directory and set your key as `sk-key`.\n\n```toml\n[OpenAI]\nOPENAI_API_KEYS = [ \"sk-key1\", \"sk-key2\",]\n\n[Gitee]\napi = \"your_gitee_api\"\nowner = \"your_gitee_name\"\nrepo = \"your_repo_name\"\npath = \"files_name_in_your_repo\"\n```\n\n### Chat Paper\n\n<img src=\"https://github.com/cauliyang/ChatResearch/blob/main//docs/tutorial/paper.gif\" width=\"800\" height=\"400\">\n\n### Chat Biorxiv\n\n<img src=\"https://github.com/cauliyang/ChatResearch/blob/main//docs/tutorial/biorxiv.gif\" width=\"800\" height=\"400\">\n\n### Chat Response\n\n<img src=\"https://github.com/cauliyang/ChatResearch/blob/main//docs/tutorial/response.gif\" width=\"800\" height=\"400\">\n\n### Chat Reviewer\n\n```console\n> chatre reviewer -h\nusage: chatre reviewer [-h] --paper-path [--file-format] [--review-format] [--research-fields] [--language]\n\noptional arguments:\n -h, --help show this help message and exit\n --paper-path path of papers\n --file-format output file format (default: txt)\n --review-format review format\n --research-fields the research fields of paper (default: computer science, artificial intelligence and reinforcement learning)\n --language output language, en or zh (default: en)\n```\n\n## :facepunch: Develop Toolkit\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Contributors\n\n- Yangyang Li\n\n![Alt](https://repobeats.axiom.co/api/embed/05714e0999ba02041b2be2307b7923d497c0b5c3.svg \"Repobeats analytics image\")\n\n## :clap: Acknowledgement\n\n- [ChatPaper](https://github.com/kaixindelele/ChatPaper/blob/main/README.md)\n- [Arxiv](https://github.com/lukasschwab/arxiv.py)\n\n<!-- links -->\n\n[black]: https://github.com/psf/black\n[license]: https://opensource.org/licenses/mit\n[precommit]: https://github.com/pre-commit/pre-commit\n[pypi status]: https://pypi.org/project/chat-research\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Use ChatGPT to accelerator your research.",
"version": "0.1.13",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "88da1c1a53972eca9c788c7b7c34a89f0558626e1eb5dfe797d06c95d5b1c81f",
"md5": "7f884c445d3881cddada3b9fe7e5b21d",
"sha256": "94ef250cfe0345d68c99fcb5471adf663f340fa2318180776f74d150d468f0df"
},
"downloads": -1,
"filename": "chat_research-0.1.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f884c445d3881cddada3b9fe7e5b21d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 81701,
"upload_time": "2023-04-11T05:00:06",
"upload_time_iso_8601": "2023-04-11T05:00:06.975987Z",
"url": "https://files.pythonhosted.org/packages/88/da/1c1a53972eca9c788c7b7c34a89f0558626e1eb5dfe797d06c95d5b1c81f/chat_research-0.1.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3a417f716f883271b5aeeab925358b9b639dc95cad7154d388b4f44335752a36",
"md5": "4575eb37aa15148100793dbbd4706ff8",
"sha256": "8a9866db146d83d4f844752857ed10f0ae8a5ff5916b8995cde55f7b7f14d584"
},
"downloads": -1,
"filename": "chat_research-0.1.13.tar.gz",
"has_sig": false,
"md5_digest": "4575eb37aa15148100793dbbd4706ff8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 60460,
"upload_time": "2023-04-11T05:00:08",
"upload_time_iso_8601": "2023-04-11T05:00:08.739346Z",
"url": "https://files.pythonhosted.org/packages/3a/41/7f716f883271b5aeeab925358b9b639dc95cad7154d388b4f44335752a36/chat_research-0.1.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-11 05:00:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "cauliyang",
"github_project": "ChatResearch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chat-research"
}
JSON
