8000 DOC: README.rst: ErrCodes, Source Links, Python Libraries · python-mode/python-mode@8d28371 · GitHub
[go: up one dir, main page]
Skip to content
8000

Commit 8d28371

Browse files
westurnerwesturner
committed
DOC: README.rst: ErrCodes, Source Links, Python Libraries
* somewhat reverts changes from: d9699cd * updated source link for pyflakes, docs * found ErrCode links
1 parent fd70ac2 commit 8d28371

File tree

1 file change 10000 d

+151
-15
lines changed

1 file changed

+151
-15
lines changed

‎README.rst

Lines changed: 151 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,23 @@
88
:target: https://www.gittip.com/klen/
99
:alt: Donate
1010

11+
|
12+
| Src: https://github.com/klen/python-mode
13+
| Homepage: https://klen.github.io/python-mode/
14+
| Docs: https://github.com/klen/python-mode/blob/develop/doc/pymode.txt
15+
|
16+
1117
Python-mode is a vim plugin that helps you to create python code very quickly
12-
by utilizing libraries including pylint_, rope_, pydoc_, pyflakes_, pep8_, and
13-
mccabe_ for features like static analysis, refactoring, folding, completion,
18+
by utilizing libraries including
19+
`pylint`_, `rope`_, pydoc_, `pyflakes`_, `pep8`_, `autopep8`_,
20+
`pep257`_ and `mccabe`_
21+
for features like static analysis, refactoring, folding, completion,
1422
documentation, and more.
1523

1624
The plugin contains all you need to develop python applications in Vim.
1725

18-
There is no need to install pylint_, rope_ or any other Python libraries on
19-
your system.
26+
There is no need to install `pylint`_, `rope`_
27+
or any other `Python Libraries`_ on your system.
2028

2129
- Support Python version 2.6+ and 3.2+
2230
- Syntax highlighting
@@ -97,13 +105,13 @@ Then rebuild **helptags** in vim::
97105

98106
Debian packages
99107
---------------
108+
|Repository URL: https://klen.github.io/python-mode/deb/
100109
101-
Repository URL: http://klen.github.io/python-mode/deb/
102110
Install with commands:
103111

104112
::
105113

106-
add-apt-repository http://klen.github.io/python-mode/deb main
114+
add-apt-repository https://klen.github.io/python-mode/deb main
107115
apt-get update
108116
apt-get install vim-python-mode
109117

@@ -176,6 +184,134 @@ https://github.com/klen/python-mode
176184
Please make a pull request to `development` branch and add yourself to
177185
`AUTHORS`.
178186

187+
Source Links
188+
===================
189+
- `doc/pymode.txt
190+
<https://github.com/klen/python-mode/blob/develop/doc/pymode.txt>`__
191+
-- ``:help pymode``
192+
- `plugin/pymode.vim
193+
<https://github.com/klen/python-mode/blob/develop/plugin/pymode.vim>`__
194+
-- python-mode VIM plugin
195+
- `syntax/python.vim
196+
<https://github.com/klen/python-mode/blob/develop/syntax/python.vim>`__
197+
-- python-mode ``python.vim`` VIM syntax
198+
- `syntax/pyrex.vim
199+
<https://github.com/klen/python-mode/blob/develop/syntax/pyrex.vim>`__
200+
-- ``pyrex.vim`` VIM syntax (pyrex, Cython)
201+
- `t/
202+
<https://github.com/klen/python-mode/tree/develop/t>`__
203+
-- ``*.vim`` more python-mode VIM configuration
204+
- `pymode/
205+
<https://github.com/klen/python-mode/tree/develop/pymode>`__
206+
-- ``*.py`` -- python-mode Python module
207+
- `pymode/libs/
208+
<https://github.com/klen/python-mode/tree/develop/pymode/libs>`__
209+
-- ``*.py`` -- `Python Libraries <#python-libraries>`__
210+
211+
212+
Python Libraries
213+
------------------
214+
Vendored Python modules are located
215+
mostly in
216+
`pymode/libs/ <https://github.com/klen/python-mode/tree/develop/pymode/libs>`__.
217+
218+
219+
======
220+
rope
221+
======
222+
| PyPI: https://pypi.python.org/pypi/rope
223+
| Src: https://github.com/python-rope/rope
224+
| Docs: https://github.com/python-rope/rope/blob/master/docs/overview.rst
225+
| Docs: https://github.com/python-rope/rope/blob/master/docs/library.rst
226+
227+
========================
228+
ropemode
229+
========================
230+
| PyPI: https://pypi.python.org/pypi/ropemode
231+
| Src: https://github.com/python-rope/ropemode
232+
233+
=========
234+
ropevim
235+
=========
236+
| PyPI: https://pypi.python.org/pypi/ropevim
237+
| Src: https://github.com/python-rope/ropevim
238+
| Docs: https://github.com/python-rope/ropevim/blob/master/doc/ropevim.txt
239+
240+
=======
241+
pylama
242+
=======
243+
| PyPI: https://pypi.python.org/pypi/pylama
244+
| Src: https://github.com/klen/pylama
245+
246+
========
247+
pylint
248+
========
249+
| PyPI: https://pypi.python.org/pypi/pylint
250+
| Src: https://bitbucket.org/logilab/pylint
251+
| Homepage: http://www.pylint.org/
252+
| Docs: http://docs.pylint.org/
253+
| Docs: http://docs.pylint.org/message-control.html
254+
| Docs: http://docs.pylint.org/faq.html#message-control
255+
| ErrCodes: http://pylint-messages.wikidot.com/all-codes
256+
| ErrCodes: http://pylint-messages.wikidot.com/all-messages
257+
258+
==========
259+
pyflakes
260+
==========
261+
| PyPI: https://pypi.python.org/pypi/pyflakes
262+
| Src: https://github.com/pyflakes/pyflakes
263+
| ErrCodes: https://flake8.readthedocs.org/en/latest/warnings.html
264+
265+
======
266+
pep8
267+
======
268+
| PyPI: https://pypi.python.org/pypi/pep8
269+
| Src: http://github.com/jcrocholl/pep8
270+
| PEP 8: http://www.python.org/dev/peps/pep-0008/
271+
| PEP 8: http://legacy.python.org/dev/peps/pep-0008/
272+
| Docs: https://pep8.readthedocs.org/en/latest/
273+
| Docs: https://pep8.readthedocs.org/en/latest/intro.html#configuration
274+
| ErrCodes: https://pep8.readthedocs.org/en/latest/intro.html#error-codes
275+
276+
=========
277+
autopep8
278+
=========
279+
| PyPI: https://pypi.python.org/pypi/autopep8
280+
| Src: https://github.com/hhatto/autopep8
281+
282+
=======
283+
pep257
284+
=======
285+
| PyPI: https://pypi.python.org/pypi/pep257
286+
| Src: http://github.com/GreenSteam/pep257
287+
| Docs: https://pep257.readthedocs.org/en/latest/
288+
| PEP 257: http://www.python.org/dev/peps/pep-0257/
289+
| ErrCodes: https://pep257.readthedocs.org/en/latest/error_codes.html
290+
291+
=======
292+
mccabe
293+
=======
294+
| PyPI: https://pypi.python.org/pypi/mccabe
295+
| Src: https://github.com/flintwork/mccabe
296+
| Docs: https://en.wikipedia.org/wiki/Cyclomatic_complexity
297+
298+
299+
Vim Libraries
300+
---------------
301+
Vendored Vim modules are located mostly in ``t/``.
302+
303+
======================
304+
Python syntax for vim
305+
======================
306+
| Src: http://www.hlabs.spb.ru/vim/python.vim
307+
308+
309+
=====================
310+
PEP8 VIM indentation
311+
=====================
312+
| Src: http://github.com/hynek/vim-python-pep8-indent
313+
314+
179315

180316
Copyright
181317
=========
@@ -192,17 +328,17 @@ My address is here: "Russia, 143500, MO, Istra, pos. Severny 8-3" to "Kirill Kle
192328
**Thanks for support!**
193329

194330
.. _GNU lesser general public license: http://www.gnu.org/copyleft/lesser.html
195-
.. _klen: http://klen.github.com/
331+
.. _klen: https://klen.github.com/
196332
.. _pydoc: http://docs.python.org/library/pydoc.html
197333
.. _pathogen: https://github.com/tpope/vim-pathogen
198-
.. _rope: https://pypi.python.org/pypi/rope
199-
.. _pylama: https://github.com/klen/pylama
200-
.. _pylint: https://bitbucket.org/logilab/pylint
201-
.. _pyflakes: https://pypi.python.org/pypi/pyflakes
202-
.. _autopep8: https://github.com/hhatto/autopep8
203-
.. _pep257: http://github.com/GreenSteam/pep257
204-
.. _mccabe: https://github.com/flintwork/mccabe
334+
.. _rope_: https://pypi.python.org/pypi/rope
335+
.. _pylama_: https://github.com/klen/pylama
336+
.. _pylint_: https://bitbucket.org/logilab/pylint
337+
.. _pyflakes_: https://pypi.python.org/pypi/pyflakes
338+
.. _autopep8_: https://github.com/hhatto/autopep8
339+
.. _pep257_: http://github.com/GreenSteam/pep257
340+
.. _mccabe_: https://github.com/flintwork/mccabe
205341
.. _pythonvim: http://www.hlabs.spb.ru/vim/python.vim
206-
.. _pep8: http://github.com/jcrocholl/pep8
342+
.. _pep8_: http://github.com/jcrocholl/pep8
207343
.. _pep8indent: http://github.com/hynek/vim-python-pep8-indent
208344
.. |logo| image:: https://raw.github.com/klen/python-mode/develop/logo.png

0 commit comments

Comments
 (0)
0