branch: elpa/flymake-pyrefly
commit 484e0d07d0ee1db840c284a1dc0a0e5d11b408f3
Merge: 61ba9c719f2 dd6517266ce
Author: Boris Shminke <1696493+inpef...@users.noreply.github.com>
Commit: GitHub <nore...@github.com>
Merge pull request #26 from inpefess/7-publish-to-nongnu-elpa
Publish to nonGNU ELPA
---
README.org | 23 ++++++++++++++++++++---
flymake-pyrefly.el | 2 +-
2 files changed, 21 insertions(+), 4 deletions(-)
diff --git a/README.org b/README.org
index 8af3160162f..8b77e92bf48 100644
--- a/README.org
+++ b/README.org
@@ -1,11 +1,28 @@
* flymake-pyrefly
-A [[https://pyrefly.org/][Pyrefly]] backend for
[[https://www.gnu.org/software/emacs/manual/html_node/flymake/index.html#Top][Flymake]].
+[[https://pyrefly.org/][Pyrefly]] is a fast Python type checker written in
Rust.
+flymake-pyrefly is a Pyrefly backend for
[[https://www.gnu.org/software/emacs/manual/html_node/flymake/index.html#Top][Flymake]]
that helps you to
+see typing errors in your Pyton files.
* How to install
+flymake-pyrefly is available on [[https://elpa.nongnu.org/][nonGNU Emacs Lisp
Package Archive]],
+so you can install it by ~M-x package-install RET flymake-pyrefly RET~.
+
+To add flymake-pyrefly to the list of Flymake backends when editing
+Python files (notice the difference if you use eglot):
+
#+begin_src elisp
+ (add-hook 'python-base-mode-hook #'pyrefly-setup-flymake-backend)
+
+ ;; alternatively, with use-package
+ (use-package flymake-pyrefly
+ :hook (python-base-mode . pyrefly-setup-flymake-backend))
+
+ ;; or if you use eglot
+ (add-hook 'eglot-managed-mode-hook #'pyrefly-setup-flymake-backen)
+
+ ;; if you use eglot and use-package
(use-package flymake-pyrefly
- :vc (:url "https://github.com/inpefess/flymake-pyrefly.git";)
- :hook (python-mode . pyrefly-setup-flymake-backend))
+ :hook (eglot-managed-mode . pyrefly-setup-flymake-backend))
#+end_src
diff --git a/flymake-pyrefly.el b/flymake-pyrefly.el
index d77781504a4..d0dd8d04c59 100644
--- a/flymake-pyrefly.el
+++ b/flymake-pyrefly.el
@@ -5,7 +5,7 @@
;; Author: Boris Shminke <bo...@shminke.com>
;; Maintainer: Boris Shminke <bo...@shminke.com>
;; Created: 29 Jun 2025
-;; Version: 0.1.4
+;; Version: 0.1.5
;; Keywords: tools, languages
;; URL: https://github.com/inpefess/flymake-pyrefly
;; Package-Requires: ((emacs "26.1"))
