PkgFoundry
Catalog PyPI
Back to packageRELEASE DETAILS

0.4.1

PyPI

academic-chatgpt

chatgpt for academic

Published29 Mar 2023
Direct dependencies7
Transitive dependenciesNot calculated

README

Version 0.4.1 documentation

ChatGPT Academic Optimizer

pypi status python version license precommit black Ruff

A simple web interface for academic research and experimentation using GPT-3.5.

This is the forked version from the project

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
FunctionDescription
One-click polishingSupports one-click polishing and finding grammar errors in papers
One-click Chinese-English translationOne-click Chinese-English translation
One-click code interpretationCan display code correctly and interpret code
Custom shortcut keysSupports custom shortcut keys
Configure proxy serverSupports configuring proxy server
Modular designSupports 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 displayCan display the tex form and rendering form of the formula at the same time
Image displayCan display images in markdown
Supports markdown tables generated by GPTSupports markdown tables generated by GPT
  • New interface
  • All buttons are dynamically generated by reading functional.py, and custom functions can be freely added to free the clipboard
  • Supports markdown tables generated by GPT
  • If the output contains formulas, it will be displayed in both tex and rendering forms at the same time for easy copying and reading
  • Too lazy to look at the project code? Just show off the chatgpt mouth

Usage

Prerequisites

  • OpenAI API key (can be obtained from here)
  • Python 3.9 or higher

Setup

$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

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.

  1. 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)"

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 7

Native requirements
7 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
gradio
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9,<4.0",
  "evaluation": "NOT_EVALUATED"
}
gradio (>=3.23.0,<4.0.0)runtime
latex2mathml
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9,<4.0",
  "evaluation": "NOT_EVALUATED"
}
latex2mathml (>=3.75.1,<4.0.0)runtime
loguru
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9,<4.0",
  "evaluation": "NOT_EVALUATED"
}
loguru (>=0.6.0,<0.7.0)runtime
mdtex2html
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9,<4.0",
  "evaluation": "NOT_EVALUATED"
}
mdtex2html (>=1.2.0,<2.0.0)runtime
pydantic
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9,<4.0",
  "evaluation": "NOT_EVALUATED"
}
pydantic (>=1.10.7,<2.0.0)runtime
requests
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9,<4.0",
  "evaluation": "NOT_EVALUATED"
}
requests (>=2.28.2,<3.0.0)runtime
toml
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9,<4.0",
  "evaluation": "NOT_EVALUATED"
}
toml (>=0.10.2,<0.11.0)runtime

Distribution files

2 collected
academic_chatgpt-0.4.1-py3-none-any.whl

bdist_wheel · 35.27 KB · Python py3

Source file
academic_chatgpt-0.4.1.tar.gz

sdist · 30.63 KB · Python source

Source file

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:50 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:dbd89dcead7d586b3bb85678075f408a4f5338ab98bb1de96392842a09068c8e

Other collected versions

View all collected versions →