emacs-openai / chatgpt

Use ChatGPT inside Emacs
GNU General Public License v3.0
185 stars 21 forks source link

Package installation instructions do not mention that "opeanai" dependency needs to be installed as well. #25

Closed progfolio closed 8 months ago

progfolio commented 10 months ago

The installation instructions for the package mention that it is available through "JCS-ELPA", which I'm assuming also hosts the "openai" package (there were no installation instructions for that library in it's repo README). Users of package managers like straight.el or Elpaca will try to install the package directly from this repo via your recipe:

(use-package chatgpt
  :straight (chatgpt :type git :host github :repo "emacs-openai/chatgpt"))

However, that will fail, because they will not have JCS-ELPA's recipes available. See: https://github.com/progfolio/elpaca/issues/199 Perhaps that should be mentioned and the installation instructions should include the declaration for "openai" and any other dependencies which are necessary and not available through the widely-used ELPAs. e.g.

(use-package openai ...) ;; Necessary if you do not have JCS-ELPA as a source for your package manager.
(use-package chatgpt
  :straight (chatgpt :type git :host github :repo "emacs-openai/chatgpt"))
jcs090218 commented 8 months ago

Sorry for the late reply. This somehow goes under my radar. Would you like to open a PR for this? Thank you!

progfolio commented 8 months ago

I don't use the package, so I'm not interested in opening a pull request. I brought this to your attention because I received bug reports on the package managers I maintain about this issue. Please fix for your users.