diff --git a/doc/python_in_emacs.org b/doc/python_in_emacs.org new file mode 100644 index 0000000..9ef1a25 --- /dev/null +++ b/doc/python_in_emacs.org @@ -0,0 +1,42 @@ +#+date: 2023-06-21 +#+options: toc:nil num:nil author:nil +#+PROPERTY: header-args:python :results output :session *python1* :tangle yes + +* Using Python in emacs + +There are different approaches to use python in ~emacs~. You may use python mode +(~python.el~) that is a default mode for using Python within ~emacs~. If you open a +file having a ~.py~ extension ~emacs~ will initialize python mode. + +There are additional packages that may be used as alternative to this mode like +~python-mode.el~ or ~elpy~. + +Basic functionalities of python modes allow the user to use code completion and +navigation, syntax checking and additional options. + +** Python mode + +[[https://gitlab.com/groups/python-mode-devs][Python-mode.el]] is a mode that extends some functionalities to work with Python +in ~emacs~. + +** Elpy + +** Pydoc + +[[https://docs.python.org/3/library/pydoc.html][Pydoc]] would allow to + +** Syntax checking + +You may use syntax checkers such as: + + * [[https://www.flycheck.org/en/latest/][Flycheck]] + * [[https://www.gnu.org/software/emacs/manual/html_node/flymake/index.html#Top][Flymake]] + + +** References + +- https://robbmann.io/posts/006_emacs_2_python/ +- https://emacs.stackexchange.com/questions/9696/how-do-you-create-a-robust-python-ide-with-emacs-as-the-text-editor +- https://realpython.com/emacs-the-best-python-editor/ +- https://wikemacs.org/wiki/Python +- https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-python.html