hiro/py-vterm-interaction.el
1
0
Fork 0
mirror of https://github.com/vale981/py-vterm-interaction.el synced 2025-03-04 17:41:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme after inclusion into MELPA

Browse source
This commit is contained in:
Valentin Boettcher 2024-09-15 13:57:34 -04:00
parent e6908089d3
commit 95d6842790
No known key found for this signature in database
GPG key ID: E034E12B7AF56ACE
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.org
View file

@ -1,5 +1,6 @@
# -*- eval: (visual-line-mode 1) -*- # -*- eval: (visual-line-mode 1) -*-
#+STARTUP: showall #+STARTUP: showall
[[https://melpa.org/packages/py-vterm-interaction-badge.svg]]
This is a port of [[https://github.com/shg/julia-vterm.el][julia-vterm.el]] with some modification to deal with This is a port of [[https://github.com/shg/julia-vterm.el][julia-vterm.el]] with some modification to deal with
python (virtual) environments and play nicely with =ipython= and the python (virtual) environments and play nicely with =ipython= and the
@ -12,8 +13,7 @@ cells (see below) or running the current function.
See also [[https://github.com/shg/python-vterm.el][the original author's efforts]]. See also [[https://github.com/shg/python-vterm.el][the original author's efforts]].
* py-vterm-interaction * py-vterm-interaction
Python-vterm provides a major-mode for an inferior Python process (or REPL) that runs in [[https://github.com/akermu/emacs-libvterm][vterm]], and a minor-mode that extends python-mode with the ability to interact with the inferior Python process. This is particularly useful for fancy REPL like =ipython= or =ptpython=.
Python-vterm provides a major-mode for an inferior Python process (or REPL) that runs in vterm, and a minor-mode that extends python-mode with the ability to interact with the inferior Python process. This is particularly useful for *fancy repls like =ipython= or =ptpython=*.
The functionalities required for typical REPL interaction have been implemented. While I would like to keep this package simple, suggestions are always welcome. The functionalities required for typical REPL interaction have been implemented. While I would like to keep this package simple, suggestions are always welcome.
@ -21,15 +21,16 @@ It is automatically detected whether the repl runs =ipython= or another
interpreter and some functions use different functionalities based on interpreter and some functions use different functionalities based on
that information. that information.
** Installation ** Installation
Currently you can only install the package from github. With The package is on melpa and depends on ~vterm~ and ~python.el~. The
~use-package~ and ~straight~ it looks as follows: simplest way to install the package is through ~use-package~:
#+begin_src elisp #+begin_src elisp
(use-package py-vterm-interaction (use-package py-vterm-interaction
:straight (:host github :repo "vale981/py-vterm-interaction.el")
:hook (python-mode . py-vterm-interaction-mode) :hook (python-mode . py-vterm-interaction-mode)
:config :config
(setq-default py-vterm-interaction-repl-program "ipython") ;;; Suggested:
(setq-default py-vterm-interaction-silent-cells t)) ;; (setq-default py-vterm-interaction-repl-program "ipython")
;; (setq-default py-vterm-interaction-silent-cells t)
)
#+end_src #+end_src
For manual installation, download =py-vterm-interaction.el= into somewhere in your local directory and use =package-install-file= command. Please make sure [[https://github.com/PythonEditorSupport/python-emacs][python-mode]] and [[https://github.com/akermu/emacs-libvterm][emacs-libvterm]] are installed and configured correctly. For manual installation, download =py-vterm-interaction.el= into somewhere in your local directory and use =package-install-file= command. Please make sure [[https://github.com/PythonEditorSupport/python-emacs][python-mode]] and [[https://github.com/akermu/emacs-libvterm][emacs-libvterm]] are installed and configured correctly.
@ -73,6 +74,7 @@ The package also contains a clone of [[https://docs.spyder-ide.org/3/editor.html
# %% <optional title> # %% <optional title>
print("block 3") print("block 3")
#+end_src #+end_src
Moving the point between any two cell markers (or between the buffer Moving the point between any two cell markers (or between the buffer
beginning/end and a marker) and executing beginning/end and a marker) and executing
~py-vterm-interaction-send-current-cell~ (=C-c C-j=) will send the contents of the ~py-vterm-interaction-send-current-cell~ (=C-c C-j=) will send the contents of the
@ -181,7 +183,6 @@ C-c C-r vterm-reset-cursor-point
** TODO fix the automatic return ** TODO fix the automatic return
- most commands should accept a prefix that control whether the code - most commands should accept a prefix that control whether the code
is exectued with =<enter>= or just pasted into the repl is exectued with =<enter>= or just pasted into the repl
** TODO overhaul session management
** TODO make an =in-repl-buffer= macro ** TODO make an =in-repl-buffer= macro
** TODO make run-current-function a bit more intelligent ** TODO make run-current-function a bit more intelligent
- detect if there are only arguments with default values - detect if there are only arguments with default values