ropemacs / docs / ropemacs.txt

=========================
 ropemacs, rope in emacs
=========================

Ropemacs is a plugin for performing python refactorings in emacs.  It
uses rope_ library and pymacs_.

You should install `rope`_ library and pymacs_ before using ropemacs.
You can download ropemacs from `project download page`_.

.. _rope: http://rope.sf.net/


Features
========

* Supports many of the refactorings that are supported by rope_
  library:

  * Rename
  * Extract method/local variable
  * Move class/function/module/package/method
  * Inline method/local variable/parameter
  * Restructuring
  * Change signature
  * ...

* Other refactoring-related features

  * Previewing refactorings
  * Undo/redo refactorings
  * Showing refactoring progress

* Code-assists

  * Code-completion
  * Goto definition
  * Show pydoc
  * Find occurrences
  * Organize imports (remove unused and duplicate imports and sort them)
  * Generating python elements


Source Repository
=================

The repository version needs ropemode (which was once part of
ropemacs); in order to use the repository version of ropemacs you need
to put ropemode in your ``PYTHONPATH``.  Note that ropemode is
included in released packages.

Ropemacs:

* repo url: http://rope.sf.net/hg/ropemacs
* snapshot: http://rope.sf.net/hg/ropemacs/archive/tip.tar.gz

Ropemode:

* repo url: http://rope.sf.net/hg/ropemode
* snapshot: http://rope.sf.net/hg/ropemode/archive/tip.tar.gz


Feedback
========

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


License
=======

Ropemacs is under the terms of GNU GPL (GNU General Public License).

.. _project download page: http://sf.net/projects/rope/files
.. _`rope-dev (at) googlegroups.com`: http://groups.google.com/group/rope-dev
.. _pymacs: http://pymacs.progiciels-bpi.ca/pymacs.html
.. _Mercurial: http://selenic.com/mercurial
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.