## researchpal: A Python Library for Automated Literature Review Generation
## What is it?
researchpal is a Python library that automates the process of generating academic literature reviews based on a research question. It utilizes external data sources to fetch research papers, synthesizes the findings, and generates a concise literature review. This library is particularly useful for researchers and students looking to streamline the literature review process.
## Features:
* Fetches research papers from Springer and Arxiv.
* Synthesizes research findings into a coherent literature review.
* Extracts citations and generates a references list.
* Supports both short(cite around 5 research papers) and long(cite around 10 research papers) literature reviews.
## Prerequisites:
Before using researchpal, ensure you have the following prerequisites:
* Python 3.8 installed on your system.
* An API key for OpenAI (required for certain functionalities).
## Installation:
To install researchpal, you can use pip:
> pip install researchpal
## Options:
* research_question: Your research question.
* openai_key: Your OpenAI API key.
* length: The length of the literature review ("short" or "long," default is "short").
## Usage:
Here's a basic example of how to use researchpal in your Python script:
> from researchpal import generate_literature_review\
\
> research_question = *"your_query"* \
> openai_key = *"your_openai_api_key"* \
> length (by default) = *"short"* # can be "short" or "long"\
\
> literature_review.generate_literature_review(research_question, openai_key, length)
## License:
This project is licensed under the MIT License.
## Support and Feedback:
For support or feedback, please contact us at info@researchpal.co
## Acknowledgments:
This library makes use of research papers from Springer API and Arxiv API, and it requires an OpenAI API key for certain functionality.
Raw data
{
"_id": null,
"home_page": "",
"name": "researchpal",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "researchpal,literature review,generate literature review,python literature",
"author": "Veracious.ai",
"author_email": "info@researchpal.co",
"download_url": "https://files.pythonhosted.org/packages/f7/01/1b2fb3d27a0dfeffaa951e4fa5ee9623b1646a4f13791fc07fbf44e77534/researchpal-1.0.1.tar.gz",
"platform": null,
"description": "\n## researchpal: A Python Library for Automated Literature Review Generation\n\n## What is it?\nresearchpal is a Python library that automates the process of generating academic literature reviews based on a research question. It utilizes external data sources to fetch research papers, synthesizes the findings, and generates a concise literature review. This library is particularly useful for researchers and students looking to streamline the literature review process.\n\n## Features:\n* Fetches research papers from Springer and Arxiv.\n* Synthesizes research findings into a coherent literature review.\n* Extracts citations and generates a references list.\n* Supports both short(cite around 5 research papers) and long(cite around 10 research papers) literature reviews.\n\n## Prerequisites:\nBefore using researchpal, ensure you have the following prerequisites:\n\n* Python 3.8 installed on your system.\n* An API key for OpenAI (required for certain functionalities).\n\n## Installation:\nTo install researchpal, you can use pip: \n\n> pip install researchpal\n\n## Options:\n* research_question: Your research question.\n* openai_key: Your OpenAI API key.\n* length: The length of the literature review (\"short\" or \"long,\" default is \"short\").\n\n## Usage:\nHere's a basic example of how to use researchpal in your Python script:\n\n> from researchpal import generate_literature_review\\\n\\\n> research_question = *\"your_query\"* \\\n> openai_key = *\"your_openai_api_key\"* \\\n> length (by default) = *\"short\"* # can be \"short\" or \"long\"\\\n\\\n> literature_review.generate_literature_review(research_question, openai_key, length)\n\n## License:\nThis project is licensed under the MIT License.\n\n## Support and Feedback:\nFor support or feedback, please contact us at info@researchpal.co\n\n## Acknowledgments:\nThis library makes use of research papers from Springer API and Arxiv API, and it requires an OpenAI API key for certain functionality.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python library for generating literature review",
"version": "1.0.1",
"project_urls": null,
"split_keywords": [
"researchpal",
"literature review",
"generate literature review",
"python literature"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "300b1864fe7233766866e0ecea8e1e8cdda90bd1fb0ae20fc318771238012efa",
"md5": "da7c28aad773d297df0c1e29722cf382",
"sha256": "c5a159143b6078d2f8a5e6e351556a51f9e9aecfc4c0d7d581f98d1bd1042a59"
},
"downloads": -1,
"filename": "researchpal-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da7c28aad773d297df0c1e29722cf382",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5810,
"upload_time": "2023-09-27T13:14:31",
"upload_time_iso_8601": "2023-09-27T13:14:31.501120Z",
"url": "https://files.pythonhosted.org/packages/30/0b/1864fe7233766866e0ecea8e1e8cdda90bd1fb0ae20fc318771238012efa/researchpal-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f7011b2fb3d27a0dfeffaa951e4fa5ee9623b1646a4f13791fc07fbf44e77534",
"md5": "31b980a5616883715c8783f46f65f7d4",
"sha256": "7abd0096e0ab880f444d43e6dd316a3b32a349001579b99b360f382880c72472"
},
"downloads": -1,
"filename": "researchpal-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "31b980a5616883715c8783f46f65f7d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4566,
"upload_time": "2023-09-27T13:14:33",
"upload_time_iso_8601": "2023-09-27T13:14:33.214297Z",
"url": "https://files.pythonhosted.org/packages/f7/01/1b2fb3d27a0dfeffaa951e4fa5ee9623b1646a4f13791fc07fbf44e77534/researchpal-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 13:14:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "researchpal"
}
JSON