rope / docs / ropeide.txt

====================================
 rope, a python refactoring IDE ...
====================================


Overview
========

`Ropeide`_ is a python refactoring IDE.  It uses rope_ library to
provide features like refactoring, code assist, and auto-completion.
It is written in python.  The IDE uses `Tkinter` library.

You should install `rope`_ library before using this IDE.

.. _`ropeide`: http://rope.sf.net/
.. _`rope`: http://rope.sf.net/


New Features
============

* Added `Core.add_extension()` for registering extension modules for
  *ropeide*
* A new open project dialog


Backward incompatible changes:

* *Ropeide* and *ropemacs* packages depend on *rope* package; *rope*
  should be installed, first
* Renamed ``rope.py`` and ``rope`` scripts to ``ropeide.py`` and
  ``ropeide``
* *Ropeide* reads ``~/.ropeide`` instead of ``~/.rope``
* `rope.ide.codeassist` was moved to `rope.contrib.codeassist`


Getting Started
===============

* Overview and keybinding: `docs/overview.txt`_
* List of features: `docs/index.txt`_
* Tutorial: `docs/tutorial.txt`_
* Contributing: `docs/contributing.txt`_

To change rope IDE preferences like font edit your ``~/.ropeide``
(which is created the first time you start rope).  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).

If you don't like rope's default emacs-like keybinding, edit the
default ``~/.ropeide`` file and change `i_like_emacs` variable to
`False`.


Bug Reports
===========

Send your bug reports and feature requests to `rope-dev (at)
googlegroups.com`_.

.. _`rope-dev (at) googlegroups.com`: http://groups.google.com/group/rope-dev


License
=======

This program is under the terms of GPL (GNU General Public License).
Have a look at ``COPYING`` file for more information.


.. _`docs/overview.txt`: docs/overview.html
.. _`docs/tutorial.txt`: docs/tutorial.html
.. _`docs/index.txt`: docs/index.html
.. _`docs/contributing.txt`: docs/contributing.html
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.