diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..9942365c76ee112a437f4fea38809ee64b3eda2c --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2014 Thiago Arruda + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 74bc2dc0394800c6833c94fa98e4404da821cfcd..68b86ccbd543930f8fb9b3fbd151c22afbc03db2 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,136 @@ -# python-neovim +Pynvim: Python client to [Neovim](https://github.com/neovim/neovim) +=================================================================== -#### 介绍 -Transition packgage for pynvim +[![Build Status](https://travis-ci.org/neovim/pynvim.svg?branch=master)](https://travis-ci.org/neovim/pynvim) +[![Documentation Status](https://readthedocs.org/projects/pynvim/badge/?version=latest)](http://pynvim.readthedocs.io/en/latest/?badge=latest) +[![Code coverage](https://codecov.io/gh/neovim/pynvim/branch/master/graph/badge.svg)](https://codecov.io/gh/neovim/pynvim) -#### 软件架构 -软件架构说明 +Pynvim implements support for python plugins in Nvim. It also works as a library for +connecting to and scripting Nvim processes through its msgpack-rpc API. +Install +------- -#### 安装教程 +Supports python 2.7, and 3.4 or later. -1. xxxx -2. xxxx -3. xxxx +```sh +pip2 install pynvim +pip3 install pynvim +``` -#### 使用说明 +If you only use one of python2 or python3, it is enough to install that +version. You can install the package without being root by adding the `--user` +flag. -1. xxxx -2. xxxx -3. xxxx +Anytime you upgrade Neovim, make sure to upgrade pynvim as well: +```sh +pip2 install --upgrade pynvim +pip3 install --upgrade pynvim +``` -#### 参与贡献 +Alternatively, the master version could be installed by executing the following +in the root of this repository: +```sh +pip2 install . +pip3 install . +``` -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +Python Plugin API +----------------- +Pynvim supports python _remote plugins_ (via the language-agnostic Nvim rplugin +interface), as well as _Vim plugins_ (via the `:python[3]` interface). Thus when +pynvim is installed Neovim will report support for the `+python[3]` Vim feature. -#### 码云特技 +The rplugin interface allows plugins to handle vimL function calls as well as +defining commands and autocommands, and such plugins can operate asynchronously +without blocking nvim. For details on the new rplugin interface, +see the [Remote Plugin](http://pynvim.readthedocs.io/en/latest/usage/remote-plugins.html) documentation. -1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md -2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目 -5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +Pynvim defines some extensions over the vim python API: + +* Builtin and plugin vimL functions are available as `nvim.funcs` +* API functions are available as `vim.api` and for objects such as `buffer.api` +* Lua functions can be defined using `vim.exec_lua` and called with `vim.lua` +* Support for thread-safety and async requests. + +See the [Python Plugin API](http://pynvim.readthedocs.io/en/latest/usage/python-plugin-api.html) documentation for usage of this new functionality. + +Development +----------- + +Use (and activate) a local virtualenv. + + python3 -m venv env36 + source env36/bin/activate + +If you change the code, you must reinstall for the changes to take effect: + + pip install . + +Use `pytest` to run the tests. Invoking with `python -m` prepends the current +directory to `sys.path` (otherwise `pytest` might find other versions!): + + python -m pytest + +For details about testing and troubleshooting, see the +[development](http://pynvim.readthedocs.io/en/latest/development.html) +documentation. + +### Usage from the Python REPL + +A number of different transports are supported, but the simplest way to get +started is with the python REPL. First, start Nvim with a known address (or use +the `$NVIM_LISTEN_ADDRESS` of a running instance): + +```sh +$ NVIM_LISTEN_ADDRESS=/tmp/nvim nvim +``` + +In another terminal, connect a python REPL to Nvim (note that the API is similar +to the one exposed by the [python-vim +bridge](http://vimdoc.sourceforge.net/htmldoc/if_pyth.html#python-vim)): + +```python +>>> from pynvim import attach +# Create a python API session attached to unix domain socket created above: +>>> nvim = attach('socket', path='/tmp/nvim') +# Now do some work. +>>> buffer = nvim.current.buffer # Get the current buffer +>>> buffer[0] = 'replace first line' +>>> buffer[:] = ['replace whole buffer'] +>>> nvim.command('vsplit') +>>> nvim.windows[1].width = 10 +>>> nvim.vars['global_var'] = [1, 2, 3] +>>> nvim.eval('g:global_var') +[1, 2, 3] +``` + +You can embed Neovim into your python application instead of connecting to +a running Neovim instance. + +```python +>>> from pynvim import attach +>>> nvim = attach('child', argv=["/bin/env", "nvim", "--embed", "--headless"]) +``` + +- The ` --headless` argument tells `nvim` not to wait for a UI to connect. +- Alternatively, use `--embed` _without_ `--headless` if your client is a UI + and you want `nvim` to wait for your client to `nvim_ui_attach` before + continuing startup. + +See the tests for more examples. + +Release +------- + +1. Create a release commit with title `Pynvim x.y.z` + - list significant changes in the commit message + - bump the version in `pynvim/util.py` and `setup.py` (3 places in total) +2. Make a release on GitHub with the same commit/version tag and copy the message. +3. Run `scripts/disable_log_statements.sh` +4. Run `python setup.py sdist` + - diff the release tarball `dist/pynvim-x.y.z.tar.gz` against the previous one. +5. Run `twine upload -r pypi dist/pynvim-x.y.z.tar.gz` + - Assumes you have a pypi account with permissions. +6. Run `scripts/enable_log_statements.sh` or `git reset --hard` to restore the working dir. diff --git a/pynvim-0.4.3.tar.gz b/pynvim-0.4.3.tar.gz new file mode 100644 index 0000000000000000000000000000000000000000..9ad541b4e7b1f8a3a8ebea872d2db0cfb5f7e7dc Binary files /dev/null and b/pynvim-0.4.3.tar.gz differ diff --git a/python-neovim.spec b/python-neovim.spec new file mode 100644 index 0000000000000000000000000000000000000000..646bcdbab0fb0c9b3875878bc7a97ce14c6b08d5 --- /dev/null +++ b/python-neovim.spec @@ -0,0 +1,45 @@ +%global desc Implements support for python plugins in Nvim. Also works as a library for\ +connecting to and scripting Nvim processes through its msgpack-rpc API. +%bcond_without sphinx +Name: python-neovim +Version: 0.4.3 +Release: 1 +License: ASL 2.0 +Summary: Python client to Neovim +URL: https://github.com/neovim/pynvim +Source0: https://github.com/neovim/pynvim/archive/0.4.3/pynvim-0.4.3.tar.gz +BuildArch: noarch +BuildRequires: make +BuildRequires: python%{python3_pkgversion}-devel +BuildRequires: python%{python3_pkgversion}-setuptools +BuildRequires: python%{python3_pkgversion}-pytest-runner + +%description +%{desc} + +%package -n python%{python3_pkgversion}-neovim +Summary: %{summary} +%{?python_provide:%python_provide python%{python3_pkgversion}-neovim} +Requires: neovim +Requires: python%{python3_pkgversion}-greenlet +Requires: python%{python3_pkgversion}-msgpack +%description -n python%{python3_pkgversion}-neovim +%{desc} + +%prep +%autosetup -n pynvim-%{version} + +%build +%py3_build + +%install +%py3_install + +%files -n python%{python3_pkgversion}-neovim +%license LICENSE +%doc README.md +%{python3_sitelib}/* + +%changelog +* Tue Jul 20 2021 anyunhao - 0.4.3-1 +- Package init