rope -- the world's most advanced open source Python refactoring library
Overview
Rope is the world's most advanced open source Python refactoring library (yes, I totally stole that tagline from Postgres).
Most Python syntax from Python 2.7 up to Python 3.9 is supported. Please file bugs and contribute patches if you encounter gaps.
Getting Started
- How to use Rope in my IDE or Text editor?
- List of features: docs/rope.rst
- Overview of some of rope's features: docs/overview.rst
- Using as a library: docs/library.rst
- Contributing: docs/contributing.rst
To change your project preferences edit
$PROJECT_ROOT/.ropeproject/config.py where $PROJECT_ROOT is
the root folder of your project (this file is created the first time
you open a project).
Why use Rope?
- Rope aims to provide powerful and safe refactoring
- Rope is light on dependency, depending only on Python itself, unlike pyright or pylance, there is no additional dependency to another language's runtime
- Unlike pylance, Rope is open source
- Unlike pyright and pylance, Rope is written in Python itself, so if you experience problems, you would be able to debug and hack it yourself in an environment that you are already familiar with
- Unlike jedi, Rope is focused on refactoring, Rope supports many advanced refactoring operations that Jedi does not support
Bug Reports
Send your bug reports and feature requests at python-rope's issue tracker in Github.
Maintainers
Current active maintainers of Rope are Matej Cepl (@mcepl) and Lie Ryan (@lieryan).
Special Thanks
Many thanks the following people:
- Ali Gholami Rudi (@aligrudi) for initially creating the initial Rope project and most of Rope's code
- Nick Smith <nicks@fastmail.fm> (@soupytwist) as former Rope maintainer
- all of our current and former contributors
- authors of editor integrations
License
This program is under the terms of LGPL v3+ (GNU Lesser General Public License). Have a look at COPYING for more information.
