Skip to content

Pathogen #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcepl merged 1 commit into from
May 22, 2014
Merged

Pathogen #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/done.txt → ChangeLog
View file
Open in desktop
File renamed without changes.
163 changes: 101 additions & 62 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,21 @@ Setting Up
First add ropevim folder to the ``PYTHONPATH`` (or install it using
``python setup.py install``).

Then load ``ropevim.vim`` in vim. That can be done either by adding
``source path/to/ropevim.vim`` to your ``~/.vimrc`` or copying it to
``~/.vim/plugin/`` folder.
Then load ``ropevim.vim`` in vim.

If you don't want to install rope and ropevim you can add something
like this to your ``~/.vimrc``::
If you don't have a preferred installation method, I recommend
installing pathogen.vim, and then simply copy and paste:

let $PYTHONPATH .= ":/path/to/rope:/path/to/ropevim"
source /path/to/ropevim.vim
cd ~/.vim/bundle
git clone https://github.com/python-rope/ropevim.git
(or even add this repo as a submodule to `~/.vim/bundle` git repo if
you have setup `~/.vim/bundle` in this way and you should)

For using the repository version of rope, see ``docs/ropevim.txt``.
Once help tags have been generated, you can view the manual with `:help
fugitive.`

For using the repository version of rope, see ``docs/ropevim.txt`` (or
vim command `:he ropevim`)


Getting Started
Expand Down Expand Up @@ -245,7 +249,7 @@ Variables

* ``ropevim_enable_autoimport``: Shows whether to enable autoimport.
* ``ropevim_autoimport_modules``: The name of modules whose global
names should be cached. `RopeGenerateAutoimportCache' reads this
names should be cached. `RopeGenerateAutoimportCache` reads this
list and fills its cache.
* ``ropevim_autoimport_underlineds``: If set, autoimport will cache
names starting with underlines, too.
Expand All @@ -262,59 +266,93 @@ Uses almost the same keybinding as ropemacs. Note that global
commands have a ``C-x p`` prefix and local commands have a ``C-c r``
prefix. You can change that (see variables_ section).

================ ============================
Key Command
================ ============================
C-x p o RopeOpenProject
C-x p k RopeCloseProject
C-x p f RopeFindFile
C-x p 4 f RopeFindFileOtherWindow
C-x p u RopeUndo
C-x p r RopeRedo
C-x p c RopeProjectConfig
C-x p n [mpfd] RopeCreate(Module|Package|File|Directory)
RopeWriteProject

C-c r r RopeRename
C-c r l RopeExtractVariable
C-c r m RopeExtractMethod
C-c r i RopeInline
C-c r v RopeMove
C-c r x RopeRestructure
C-c r u RopeUseFunction
C-c r f RopeIntroduceFactory
C-c r s RopeChangeSignature
C-c r 1 r RopeRenameCurrentModule
C-c r 1 v RopeMoveCurrentModule
C-c r 1 p RopeModuleToPackage

C-c r o RopeOrganizeImports
C-c r n [vfcmp] RopeGenerate(Variable|Function|Class|Module|Package)

C-c r a / RopeCodeAssist
C-c r a g RopeGotoDefinition
C-c r a d RopeShowDoc
C-c r a f RopeFindOccurrences
C-c r a ? RopeLuckyAssist
C-c r a j RopeJumpToGlobal
C-c r a c RopeShowCalltip
RopeAnalyzeModule

RopeAutoImport
RopeGenerateAutoimportCache
=============== ============================


Shortcuts
---------

Some commands are used very frequently; specially the commands in
code-assist group. You can define your own shortcuts like this::

:map <C-c>g :call RopeGotoDefinition()

Ropevim itself comes with a few shortcuts. These shortcuts will be
used only when ``ropevim_enable_shortcuts`` is set.
+-----------------+-------------------------------------------------------+
|Key | Command |
+=================+=======================================================+
|C-x p o | RopeOpenProject |
+-----------------+-------------------------------------------------------+
|C-x p k | RopeCloseProject |
+-----------------+-------------------------------------------------------+
|C-x p f | RopeFindFile |
+-----------------+-------------------------------------------------------+
|C-x p 4 f | RopeFindFileOtherWindow |
+-----------------+-------------------------------------------------------+
|C-x p u | RopeUndo |
+-----------------+-------------------------------------------------------+
|C-x p r | RopeRedo |
+-----------------+-------------------------------------------------------+
|C-x p c | RopeProjectConfig |
+-----------------+-------------------------------------------------------+
|C-x p n [mpfd] | RopeCreate(Module|Package|File|Directory) |
+-----------------+-------------------------------------------------------+
| | RopeWriteProject |
+-----------------+-------------------------------------------------------+
| | |
+-----------------+-------------------------------------------------------+
|C-c r r | RopeRename |
+-----------------+-------------------------------------------------------+
|C-c r l | RopeExtractVariable |
+-----------------+-------------------------------------------------------+
|C-c r m | RopeExtractMethod |
+-----------------+-------------------------------------------------------+
|C-c r i | RopeInline |
+-----------------+-------------------------------------------------------+
|C-c r v | RopeMove |
+-----------------+-------------------------------------------------------+
|C-c r x | RopeRestructure |
+-----------------+-------------------------------------------------------+
|C-c r u | RopeUseFunction |
+-----------------+-------------------------------------------------------+
|C-c r f | RopeIntroduceFactory |
+-----------------+-------------------------------------------------------+
|C-c r s | RopeChangeSignature |
+-----------------+-------------------------------------------------------+
|C-c r 1 r | RopeRenameCurrentModule |
+-----------------+-------------------------------------------------------+
|C-c r 1 v | RopeMoveCurrentModule |
+-----------------+-------------------------------------------------------+
|C-c r 1 p | RopeModuleToPackage |
+-----------------+-------------------------------------------------------+
| | |
+-----------------+-------------------------------------------------------+
|C-c r o | RopeOrganizeImports |
+-----------------+-------------------------------------------------------+
|C-c r n [vfcmp] | RopeGenerate(Variable|Function|Class|Module|Package) |
+-----------------+-------------------------------------------------------+
| | |
+-----------------+-------------------------------------------------------+
|C-c r a / | RopeCodeAssist |
+-----------------+-------------------------------------------------------+
|C-c r a g | RopeGotoDefinition |
+-----------------+-------------------------------------------------------+
|C-c r a d | RopeShowDoc |
+-----------------+-------------------------------------------------------+
|C-c r a f | RopeFindOccurrences |
+-----------------+-------------------------------------------------------+
|C-c r a ? | RopeLuckyAssist |
+-----------------+-------------------------------------------------------+
|C-c r a j | RopeJumpToGlobal |
+-----------------+-------------------------------------------------------+
|C-c r a c | RopeShowCalltip |
+-----------------+-------------------------------------------------------+
| | RopeAnalyzeModule |
+-----------------+-------------------------------------------------------+
| | RopeAutoImport |
+-----------------+-------------------------------------------------------+
| | RopeGenerateAutoimportCache |
+-----------------+-------------------------------------------------------+


Shortcuts
---------

Some commands are used very frequently; specially the commands in
code-assist group. You can define your own shortcuts like this::

:map <C-c>g :call RopeGotoDefinition()

Ropevim itself comes with a few shortcuts. These shortcuts will be
used only when ``ropevim_enable_shortcuts`` is set.

================ ============================
Key Command
Expand All @@ -333,6 +371,7 @@ Support for Omni completion
You can enable using Rope as providing for Omni completion by setting
omnifunc variable to ``RopeCompleteFunc``. E.g., by putting something
like this in your ``~/.vimrc``::

autocmd FileType python setlocal omnifunc=RopeCompleteFunc


Expand Down
0 docs/ropevim.txt → doc/ropevim.txt
View file
Open in desktop
File renamed without changes.
30 changes: 30 additions & 0 deletions doc/tags
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
'pymode_rope_always_show_complete_menu' ropevim.txt /*'pymode_rope_always_show_complete_menu'*
'pymode_rope_autoimport_modules' ropevim.txt /*'pymode_rope_autoimport_modules'*
'pymode_rope_autoimport_underlineds' ropevim.txt /*'pymode_rope_autoimport_underlineds'*
'pymode_rope_codeassist_maxfixes' ropevim.txt /*'pymode_rope_codeassist_maxfixes'*
'pymode_rope_enable_autoimport' ropevim.txt /*'pymode_rope_enable_autoimport'*
'pymode_rope_enable_shortcuts' ropevim.txt /*'pymode_rope_enable_shortcuts'*
'pymode_rope_extended_complete' ropevim.txt /*'pymode_rope_extended_complete'*
'pymode_rope_global_prefix' ropevim.txt /*'pymode_rope_global_prefix'*
'pymode_rope_goto_def_newwin' ropevim.txt /*'pymode_rope_goto_def_newwin'*
'pymode_rope_guess_project' ropevim.txt /*'pymode_rope_guess_project'*
'pymode_rope_local_prefix' ropevim.txt /*'pymode_rope_local_prefix'*
'pymode_rope_vim_completion' ropevim.txt /*'pymode_rope_vim_completion'*
:RopeCodeAssist ropevim.txt /*:RopeCodeAssist*
:RopeFindFile ropevim.txt /*:RopeFindFile*
:RopeFindFileOtherWindow ropevim.txt /*:RopeFindFileOtherWindow*
:RopeGenerateAutoimportCache ropevim.txt /*:RopeGenerateAutoimportCache*
:RopeLuckyAssist ropevim.txt /*:RopeLuckyAssist*
:RopevimAutoImport ropevim.txt /*:RopevimAutoImport*
RopeCodeAssist ropevim.txt /*RopeCodeAssist*
RopeDialogBatchsetCommand ropevim.txt /*RopeDialogBatchsetCommand*
RopeEnablingAutoimport ropevim.txt /*RopeEnablingAutoimport*
RopeFilteringResources ropevim.txt /*RopeFilteringResources*
RopeFindOccurrences ropevim.txt /*RopeFindOccurrences*
RopeFindingFiles ropevim.txt /*RopeFindingFiles*
RopeKeys ropevim.txt /*RopeKeys*
RopeRefactoringDialog ropevim.txt /*RopeRefactoringDialog*
RopeShortcuts ropevim.txt /*RopeShortcuts*
RopeVariables ropevim.txt /*RopeVariables*
Ropevim ropevim.txt /*Ropevim*
ropevim.txt ropevim.txt /*ropevim.txt*
8 changes: 0 additions & 8 deletions docs/todo.txt
View file
Open in desktop

This file was deleted.

0 ropevim.vim → plugin/ropevim.vim
View file
Open in desktop
File renamed without changes.
1 change: 0 additions & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,5 @@ def get_long_description():
license='GNU GPL',
classifiers=classifiers,
requires=['ropemode'],
data_files=[('share/vim/plugin', ['ropevim.vim'])],
**extra_kwargs
)