@@ -33,7 +33,7 @@ pynvim is installed Neovim will report support for the `+python3` Vim feature.
33
33
34
34
The rplugin interface allows plugins to handle vimL function calls as well as
35
35
defining commands and autocommands, and such plugins can operate asynchronously
36
- without blocking nvim. For details on the new rplugin interface,
36
+ without blocking nvim. For details on the new rplugin interface,
37
37
see the [ Remote Plugin] ( http://pynvim.readthedocs.io/en/latest/usage/remote-plugins.html ) documentation.
38
38
39
39
Pynvim defines some extensions over the vim python API:
@@ -70,7 +70,7 @@ documentation.
70
70
71
71
A number of different transports are supported, but the simplest way to get
72
72
started is with the python REPL. First, start Nvim with a known address (or use
73
- the ` $NVIM_LISTEN_ADDRESS ` of a running instance):
73
+ the ` $NVIM_LISTEN_ADDRESS ` of a running instance):
74
74
75
75
``` sh
76
76
$ NVIM_LISTEN_ADDRESS=/tmp/nvim nvim
@@ -81,10 +81,10 @@ to the one exposed by the [python-vim
81
81
bridge] ( http://vimdoc.sourceforge.net/htmldoc/if_pyth.html#python-vim ) ):
82
82
83
83
``` python
84
- >> > from pynvim import attach
84
+ >> > import pynvim
85
85
# Create a python API session attached to unix domain socket created above:
86
- >> > nvim = attach(' socket' , path = ' /tmp/nvim' )
87
- # Now do some work.
86
+ >> > nvim = pynvim. attach(' socket' , path = ' /tmp/nvim' )
87
+ # Now do some work.
88
88
>> > buffer = nvim.current.buffer # Get the current buffer
89
89
>> > buffer[0 ] = ' replace first line'
90
90
>> > buffer[:] = [' replace whole buffer' ]
@@ -99,16 +99,16 @@ You can embed Neovim into your python application instead of connecting to
99
99
a running Neovim instance.
100
100
101
101
``` python
102
- >> > from pynvim import attach
103
- >> > nvim = attach(' child' , argv = [" /bin/env" , " nvim" , " --embed" , " --headless" ])
102
+ >> > import pynvim
103
+ >> > nvim = pynvim. attach(' child' , argv = [" /usr /bin/env" , " nvim" , " --embed" , " --headless" ])
104
104
```
105
105
106
- - The ` --headless` argument tells ` nvim ` not to wait for a UI to connect.
106
+ - The ` --headless ` argument tells ` nvim ` not to wait for a UI to connect.
107
107
- Alternatively, use ` --embed ` _ without_ ` --headless ` if your client is a UI
108
108
and you want ` nvim ` to wait for your client to ` nvim_ui_attach ` before
109
109
continuing startup.
110
110
111
- See the tests for more examples.
111
+ See the [ tests] ( https://github.com/neovim/pynvim/tree/master/test ) for more examples.
112
112
113
113
Release
114
114
-------
@@ -123,3 +123,8 @@ Release
123
123
5 . Run ` twine upload -r pypi dist/* `
124
124
- Assumes you have a pypi account with permissions.
125
125
6 . Run ` scripts/enable_log_statements.sh ` or ` git reset --hard ` to restore the working dir.
126
+
127
+ License
128
+ -------
129
+
130
+ [ Apache License 2.0] ( https://github.com/neovim/pynvim/blob/master/LICENSE )
0 commit comments