Skip to content

How to use Rope in my IDE or Text editor?

lieryan edited this page Sep 19, 2021 · 36 revisions

This page documents all known first and third party projects that supports rope, links to documentation on how to use rope in that environments, what features are supported, and whether or not the project is still maintained.

Use this page to help you decide the best option for you to integrate rope to your development environment.

Vim

  • ropevim: reference implementation, currently the most feature complete rope plugin that can be used in vim.

    • Set up guide: TODO
    • Usage guide: TODO
    • Supported feature matrix: TODO
  • python-mode: implements most of rope functionality. The UI is a bit more polished than ropevim and it already implements most of rope, but it's missing a few of the more advanced refactoring options.

    • Set up guide: TODO
    • Usage guide: TODO
    • Supported features matrix: TODO

Emacs

  • ropemacs: reference implementation, currently the most feature complete rope plugin that can be used in emacs.

    • Set up guide: TODO
    • Usage guide: TODO
    • Supported features matrix: TODO
  • elpy: ...

    • Set up guide: TODO
    • Usage guide: TODO
    • Supported features matrix: TODO
  • traad: ...

    • Set up guide: TODO
    • Usage guide: TODO
    • Supported features matrix: TODO

Language Server Protocol (LSP)

  • python-lsp-server (pylsp): a maintained, community fork of python-language-server. Currently, pylsp only supports only renaming and code completion, if you want to use full rope capability you are still going to need to find native integrations.

    • Set up guide: TODO
    • Usage guide: TODO
    • Supported features matrix: TODO
  • python-language-server (pyls): Not recommended. You should switch to python-lsp-server if you're still using pyls.

VSCode:

TODO: help needed by regular users of this IDE/editor to expand on this section

  • vscode-python: vscode-python has recently removed its native rope integration in favor of LSP integration (TODO: add last supported vscode-python version that still supports native rope)
    • Set up guide: TODO
    • Usage guide: TODO
    • Supported features matrix: TODO

Sublime text

TODO: help needed by regular users of this IDE/editor to expand on this section

  • PyRefactor
    • Set up guide: TODO
    • Usage guide: TODO
    • Supported features matrix: TODO

Spyder

TODO: help needed by regular users of this IDE/editor to expand on this section

Eric

TODO: help needed by regular users of this IDE/editor to expand on this section

kakoune

TODO: help needed by regular users of this IDE/editor to expand on this section

  • kak-rope
    • Set up guide: TODO
    • Usage guide: TODO
    • Supported features matrix: TODO

CLI/Shell

TODO: help needed by regular users of this IDE/editor to expand on this section

  • roper
    • Set up guide: TODO
    • Usage guide: TODO
    • Supported features matrix: TODO

ropeide

A standalone IDE specifically developed to showcase the use of Rope. This project is no longer maintained and is not recommended for use.

How to help?

If your favorite IDE/text editor or integration is not listed in this page, feel free to add them to this page. Also if you believe some information here is is missing or incorrect, you're welcome to edit this page.

Clone this wiki locally