Skip to content

Commit ef57d2b

Browse files
committed
Document Docker usage.
1 parent 95e5d08 commit ef57d2b

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,25 @@ Usage
2222
-----
2323

2424
This library provide function for convenient running python on
25-
different platforms on local and remote hosts.
25+
different platforms on local and remote hosts including Docker
26+
containers. To use ``pythonic`` with Docker you need to install
27+
`docker-tramp`_ Emacs package.
2628

2729
You can use remote interpreter
2830

2931
.. code:: lisp
3032
3133
(setq python-shell-interpreter "/ssh:user@host:/usr/bin/python")
34+
;; or
35+
(setq python-shell-interpreter "/docker:root@container:/usr/bin/python")
3236
3337
You can use remote virtual environment
3438

3539
.. code:: lisp
3640
3741
(setq python-shell-virtualenv-root "/ssh:user@host:env")
42+
;; or
43+
(setq python-shell-virtualenv-root "/docker:root@container:/src/app/env")
3844
3945
``python-shell-exec-path`` and ``python-shell-process-environment``
4046
will be translated to remote host too.
@@ -106,3 +112,4 @@ pythonic-deactivate
106112
Deactivate python virtual environment.
107113

108114
.. _Melpa: http://melpa.org
115+
.. _docker-tramp: https://github.com/emacs-pe/docker-tramp.el

0 commit comments

Comments
 (0)