Merge branch 'master' of gh:ivanov/vim-ipython

ivanov · ivanov · commit 97b2e6964576 · 2013-10-29T11:32:48.000-07:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+Thanks so much for reporting issues or proposing new changes to vim-ipython.
+
+# Issues
+
+If you are reporting an issue, please be sure to read through the [Known
+Issues](https://github.com/ivanov/vim-ipython#known-issues) portion of [the
+README document](/README.rst), as the most common issues, and their workaround
+are described there
+
+# Pull requests
+
+Thanks for making a pull request. Please be sure to add your GitHub username to
+the [Thanks and Bug
+Participation](https://github.com/ivanov/vim-ipython#thanks-and-bug-participation)
+list, and if it's a significant enough of a feature, to also add it somewhere
+within the overall guide found in the README.
+
+best,
+pi
diff --git a/README.rst b/README.rst
@@ -199,6 +199,13 @@ editor and REPL combination.
 Known issues:
 ---------------
 - For now, vim-ipython only connects to an ipython session in progress.
+- The standard ipython clients (console, qtconsole, notebook) do not currently
+  display the result of computation which they did not initialize. This means
+  that if you send print statements for execution from within vim, they will
+  only be shown inside the vim-ipython shell buffer, but **not** within any of
+  the standard clients. This is not a limitation of vim-ipython, but a
+  limitation of those built-in clients, see `ipython/ipython#1873
+  <https://github.com/ipython/ipython/issues/1873>`_
 - The ipdb integration is not yet re-implemented. Pending 
   [IPython PR #3089](https://github.com/ipython/ipython/pull/3089)
 - If you're running inside ``screen``, read about the ``<CTRL-S>`` issue `here
diff --git a/ftplugin/python/ipy.vim b/ftplugin/python/ipy.vim
@@ -78,12 +78,25 @@ except NameError:
     kc = None
     pid = None
 
+_install_instructions = """You *must* install IPython into the Python that
+your vim is linked against. If you are seeing this message, this usually means
+either (1) installing IPython using the system Python that vim is using, or
+(2) recompiling Vim against the Python where you already have IPython
+installed. This is only a requirement to allow Vim to speak with an IPython
+instance using IPython's own machinery. It does *not* mean that the IPython
+instance with which you communicate via vim-ipython needs to be running the
+same version of Python.
+"""
 def km_from_string(s=''):
     """create kernel manager from IPKernelApp string
     such as '--shell=47378 --iopub=39859 --stdin=36778 --hb=52668' for IPython 0.11
     or just 'kernel-12345.json' for IPython 0.12
     """
     from os.path import join as pjoin
+    try:
+        import IPython
+    except ImportError:
+        raise ImportError("Could not find IPython. " + _install_instructions)
     from IPython.config.loader import KeyValueConfigLoader
     from Queue import Empty
     try:
@@ -432,8 +445,8 @@ def with_subchannel(f,*args):
 
 @with_subchannel
 def run_this_file():
-    msg_id = send('run %s %s' % (run_flags, repr(vim.current.buffer.name),))
-    print_prompt("In[]: run %s %s" % (run_flags, repr(vim.current.buffer.name)),msg_id)
+    msg_id = send('%%run %s %s' % (run_flags, repr(vim.current.buffer.name),))
+    print_prompt("In[]: %%run %s %s" % (run_flags, repr(vim.current.buffer.name)),msg_id)
 
 @with_subchannel
 def run_this_line():
