Source

rope / docs / rope.txt

========================================
 rope, a python refactoring library ...
========================================


Overview
========

`Rope`_ is a python refactoring library.

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


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

* Added *ropemacs* package for using rope in emacs


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
===============

* List of features: `docs/index.txt`_
* Using as a library: `docs/library.txt`_
* Contributing: `docs/contributing.txt`_

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).


Project Road Map
================

The main motive for starting this project was the lack of good
refactoring tools for Python programming language.  Refactoring
programs like "bicycle repair man" aren't reliable due to type
inference problems and they support a limited number of refactorings.
*Rope* tries to improve these limitations.

The main goal of *rope* is to concentrate on the type inference and
refactoring of python programs and not a state of art IDE (at least
not in the first phase).  The type inference and refactoring parts
will not be dependent on *rope* IDE and if successful, will be
released as standalone programs and libraries so that other projects
may use them.


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/index.txt`: docs/index.html
.. _`docs/contributing.txt`: docs/contributing.html
.. _`docs/library.txt`: docs/library.html