https://github.com/pythonic-emacs/pythonic
Utility functions for writing pythonic emacs package.
https://github.com/pythonic-emacs/pythonic
Last synced: 5 months ago
JSON representation
Utility functions for writing pythonic emacs package.
- Host: GitHub
- URL: https://github.com/pythonic-emacs/pythonic
- Owner: pythonic-emacs
- Created: 2015-01-21T07:45:33.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T10:59:05.000Z (9 months ago)
- Last Synced: 2024-08-05T06:05:40.542Z (9 months ago)
- Language: Emacs Lisp
- Size: 102 KB
- Stars: 45
- Watchers: 6
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
README
[](https://melpa.org/#/pythonic)
[](https://stable.melpa.org/#/pythonic)
# Pythonic
[](https://github.com/pythonic-emacs/pythonic/actions/workflows/test.yml)
Utility functions for writing pythonic emacs package.
## Installation
You can install this package form [Melpa](http://melpa.org)
M-x package-install RET pythonic RET
## Usage
This library provide function for convenient running python on
different platforms on local and remote hosts including Docker
containers and Vagrant virtual machines. To use `pythonic` with
Docker you need to install
[docker-tramp](https://github.com/emacs-pe/docker-tramp.el) Emacs
package.
You can use remote interpreter from the tramp buffer.
```lisp
(cd "/ssh:user@host:/home/user/")
;; or
(cd "/docker:root@container:/root/")
```
## Functions
### pythonic-call-process
Pythonic wrapper around `call-process`.
FILE is the input file. BUFFER is the output destination. DISPLAY
specifies to redisplay BUFFER on new output. ARGS is the list of
arguments passed to `call-process`. CWD will be working directory for
running process.
```lisp
(pythonic-call-process :buffer "*Pythonic*"
:args '("-V")
:cwd "~")
```
### pythonic-start-process
Pythonic wrapper around `start-process`.
PROCESS is a name of the created process. BUFFER is a output
destination. ARGS are the list of args passed to `start-process`. CWD
will be working directory for running process. FILTER must be a
symbol of process filter function if necessary. SENTINEL must be a
symbol of process sentinel function if necessary. QUERY-ON-EXIT will
be corresponding process flag.
```lisp
(pythonic-start-process :process "pythonic"
:buffer "*Pythonic*"
:args '("-c" "print('PING')")
:cwd "~"
:filter (lambda (process output) (message output))
:sentinel (lambda (process event) (message "Done."))
:query-on-exit nil)
```
### pythonic-remote-p
Determine remote or local virtual environment.
```lisp
(pythonic-remote-p)
```
### pythonic-remote-docker-p
Determine docker remote virtual environment.
```lisp
(pythonic-remote-docker-p)
```
### pythonic-remote-vagrant-p
Determine vagrant remote virtual environment.
```lisp
(pythonic-remote-vagrant-p)
```
### pythonic-remote-user
Get user of the connection to the remote python interpreter.
```lisp
(pythonic-remote-user)
```
### pythonic-remote-host
Get host of the connection to the remote python interpreter.
```lisp
(pythonic-remote-host)
```
### pythonic-remote-port
Get port of the connection to the remote python interpreter.
```lisp
(pythonic-remote-port)
```
## Commands
### pythonic-activate
Activate python virtual environment. Tramp paths are supported.
### pythonic-deactivate
Deactivate python virtual environment.
## Project settings
You can change the default docker-compose file name and set a default
service name to run the pythonic commands.
Add these lines to the `.dir-locals.el` file in the project root
directory.
```lisp
((python . ((pythonic-docker-compose-filename . "local.yml")
(pythonic-docker-compose-service-name . "web"))))
```
You can change the interpreter that pythonic uses. This is especially useful when you have set your `python-shell-interpreter` to something like `jupyter-console`. By default, it'll use `python-shell-interpreter`.
To change it:
```lisp
(setq pythonic-interpreter "python")
```