sage-shell-mode is an elisp package and provides an Emacs front end for Sage.

By sage-shell-mode, you can run Sage process in GNU Emacs and send contents of a buffer or a file to the Sage process.

This package also provides a major-mode derived from python-mode.

There are extensions for this package, auto-complete-sage, helm-sage and anything-sage.

• Installation and Setup
• Aliases
• Basic Usage
• Input history
• SageTeX
• Customization
• Extensions
• Screenshots
• Workaround for flycheck
• License

You can install sage-shell-mode from MELPA.

1. See http://melpa.org/#/getting-started if you do not have a configuration for MELPA.
2. Install sage-shell-mode by M-x package-install RET sage-shell-mode RET.
3. You can run Sage inside Emacs by M-x sage-shell:run-sage if Emacs can find the executable file of Sage.

If Emacs cannot find the executable file, put the following line to ~/.emacs.d/init.el.

(setq sage-shell:sage-root "/path/to/sage/root_directory")

And replace /path/to/sage_root_directory by the root directory of Sage, i.e. $SAGE_ROOT. If you do not know the root directory of Sage, evaluate the following code in Sage:

import os; print os.environ["SAGE_ROOT"]

Alternatively, instead of setting sage-shell:sage-root, you may set the variable sage-shell:sage-executable.

(setq sage-shell:sage-executable "/path/to/sage/executable")

Here /path/to/sage/executable is the path of the executable file of Sage. This may be a symbolic link.

Here is a sample configuration.

;; Run SageMath by M-x run-sage instead of M-x sage-shell:run-sage
(sage-shell:define-alias)
;; Turn on eldoc-mode
(add-hook 'sage-shell-mode-hook #'eldoc-mode)
(add-hook 'sage-shell:sage-mode-hook #'eldoc-mode)

The major mode sage-mode and the command run-sage are provided by sage-mode (the official sage-mode). To avoid name conflicts, sage-shell-mode uses redundant names. By putting the following code in ~/.emacs.d/init.el,

(sage-shell:define-alias)

the following aliases will be defined.

Then you can run Sage by M-x run-sage instead of M-x sage-shell:run-sage with these aliases.

You can run Sage by M-x sage-shell:run-sage. You can run new Sage process by M-x sage-shell:run-new-sage.

The major-mode of the Sage process buffer is sage-shell-mode. The basic key-bidings in sage-shell-mode are as follows:

For more commands and key-bindings see the help by M-x describle-mode sage-shell-mode.

By default, TAB completion uses completion-at-point. You can use pcomplete by the following setting:

(setq sage-shell:completion-function 'pcomplete)

You can also use auto-complete, anything or helm for completion. This requires extensions.

When you visit a file ended with .sage, then sage-shell:sage-mode will be the major-mode of the buffer automatically. If you want to edit a file ended with .py in sage-shell:sage-mode, then use the following magic comment at the first line of the file:

# -*- mode: sage-shell:sage -*-

With aliases above, instead of the line above you can use the following magic comment:

# -*- mode: sage -*-

The major mode sage-shell:sage-mode is almost same as python-mode you use. The differences are some of key-bidings.

The basic key-bidings in sage-shell:sage-mode are as follows:

If you run multiple Sage processes, you can choose which process to send by M-x sage-shell:set-process-buffer.

If the variable sage-shell:input-history-cache-file is non-nil and it is a file name, then the input history (comint-input-ring) will be saved to the file. Here is a sample configuration:

(setq sage-shell:input-history-cache-file "~/.emacs.d/.sage_shell_input_history")

When a Sage process is spawned by sage-shell:run-sage or sage-shell:run-new-sage, then sage-shell-mode adds $SAGE_ROOT/local/share/texmf/tex/generic/sagetex/ to the environment variable TEXINPUTS in Emacs. If you do not want to change the environment variable, set sage-shell-sagetex:add-to-texinputs-p to nil.

Here is a list of commands for SageTeX. These commands load a .sagetex.sage file generated by SageTeX to the existing Sage process.

There are similar commands to above, sage-shell-sagetex:load-current-file, sage-shell-sagetex:run-latex-and-load-current-file and sage-shell-sagetex:compile-current-file.

Here is a sample setting for AUCTeX users.

(eval-after-load "latex"
  '(mapc (lambda (key-cmd) (define-key LaTeX-mode-map (car key-cmd) (cdr key-cmd)))
         `((,(kbd "C-c s c") . sage-shell-sagetex:compile-current-file)
           (,(kbd "C-c s C") . sage-shell-sagetex:compile-file)
           (,(kbd "C-c s r") . sage-shell-sagetex:run-latex-and-load-current-file)
           (,(kbd "C-c s R") . sage-shell-sagetex:run-latex-and-load-file)
           (,(kbd "C-c s l") . sage-shell-sagetex:load-current-file)
           (,(kbd "C-c s L") . sage-shell-sagetex:load-file)
           (,(kbd "C-c C-z") . sage-shell-edit:pop-to-process-buffer))))

For example, you can run sage-shell-sagetex:compile-current-file by C-c s c in a LaTeX-mode buffer with this setting.

You can change a latex command used by sage-shell-sagetex:compile-file and sage-shell-sagetex:compile-current-file by setting sage-shell-sagetex:latex-command or sage-shell-sagetex:auctex-command-name.

If you are an AUCTeX user, then customize sage-shell-sagetex:auctex-command-name to change the latex command. The value of sage-shell-sagetex:auctex-command-name should be a name of a command in TeX-command-list (i.e car of an element of the list TeX-command-list), e.g.:

(setq sage-shell-sagetex:auctex-command-name "LaTeX")

You can also use the variable sage-shell-sagetex:latex-command to change the latex command. For example, if you want to run latexmk after loading a .sagetex.sage file, then use the following setting:

(setq sage-shell-sagetex:latex-command "latexmk")

The default value of sage-shell-sagetex:latex-command is latex -interaction=nonstopmode. If sage-shell-sagetex:auctex-command-name is non-nil, then the value of sage-shell-sagetex:latex-command is ignored.

To customize sage-shell-mode, M-x customize-group RET sage-shell or M-x customize-group RET sage-shell-sagetex.

• auto-complete-sage provides an auto-complete source for sage-shell-mode.
• helm-sage provides a helm source for sage-shell-mode.
• anything-sage provides an anything source for sage-shell-mode.

Automatic indentation and syntax highlighting work.

Completion with auto-complete-sage.

Completion with helm-sage.

To use flycheck-mode in a sage-shell:sage-mode buffer and a python-mode buffer, try the following code.

(defun sage-shell:flycheck-add-mode (checker mode) "Add `mode' to
  `checker'."  (let ((modes (get checker 'flycheck-modes)))
  (unless (memq mode modes) (put checker 'flycheck-modes (cons
  mode modes)))))

(dolist (ckr '(python-pylint python-flake8))
  (sage-shell:flycheck-add-mode ckr 'sage-shell:sage-mode))

(defun sage-shell:flycheck-turn-on () "Enable flycheck-mode only
  in a file ended with py."  (when (let ((bfn (buffer-file-name)))
  (and bfn (string-match (rx ".py" eol) bfn))) (flycheck-mode 1)))

(add-hook 'python-mode-hook 'sage-shell:flycheck-turn-on)

Licensed under the GPL.