Anonymous avatar Anonymous committed 81f1019

Separating README.txt files for different packages

Comments (0)

Files changed (10)

README.txt

-================================================
- rope, a python refactoring IDE and library ...
-================================================
-
-
-Overview
-========
-
-`Rope`_ is a python refactoring library and IDE.  The IDE uses the
-library to provide features like refactoring, code assist, and
-auto-completion.  It is written in python.  The IDE uses `Tkinter`
-library.
-
-Ropeide and library are released in two separate packages.  You should
-install rope before using the library.
-
-.. _`rope`: http://rope.sf.net/
-
-
-New Features
-============
-
-* *Ropemacs* package for using rope in emacs
-* 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`_
-* Using as a library: `docs/library.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`.
-
-
-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.
-
-
-Get Involved!
-=============
-
-See `docs/contributing.txt`_.
-
-
-Bug Reports
-===========
-
-Send your bug reports and feature requests in *rope*'s sourceforge.net
-project page at http://sf.net/projects/rope.
-
-
-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
-.. _`docs/library.txt`: docs/library.html

docs/dev/workingon.txt

 Plans For New Packages
 ======================
 
-- Renaming `rope.ide` to `rope.contrib`
-- Renaming `rope.ui` to `ropeide`
-- Renaming ``rope.py`` to ``ropeide.py``
-- Renaming `rope.contrib.ropemacs` to `ropemacs`
-- Three separate packages: rope, ropeide, ropemacs
-- Separating ropeide tests
-- Renaming ``~/.rope`` to ``~/.ropeide``
-- Documenting backward incompatible changes
-
 * Separating docs for different packages; different ``README.txt``\s?
 * Updating docs
-* Adding docs for using code assist to ``library.txt``
 
 ===========================  =============================
 Filename                     Belongs to
+========================================
+ rope, a python refactoring library ...
+========================================
+
+
+Overview
+========
+
+`Rope`_ is a python refactoring library.
+
+.. _`rope`: http://rope.sf.net/
+
+
+New Features
+============
+
+* *Ropemacs* package for using rope in emacs
+* 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
+===============
+
+* 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 in *rope*'s sourceforge.net
+project page at http://sf.net/projects/rope.
+
+
+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
+====================================
+ 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.
+
+.. _`rope`: http://rope.sf.net/
+
+
+New Features
+============
+
+* *Ropemacs* package for using rope in emacs
+* 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 in *rope*'s sourceforge.net
+project page at http://sf.net/projects/rope.
+
+
+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

docs/ropemacs.txt

 Setting Up
 ==========
 
-After installing pymacs add these lines to your ``~/.emacs`` file::
+After installing pymacs, add these lines to your ``~/.emacs`` file::
 
   (load-library "pymacs")
   (pymacs-load "ropemacs" "rope-")
 ==========
 
 Uses the same keybinding as in rope.
+
+
+License
+=======
+
+This program is under the terms of GPL (GNU General Public License).
+Have a look at ``COPYING`` file for more information.

ropeide/helpactions.py

     toplevel.bind('<Return>', lambda event: ok())
 
 def show_doc(context, name):
-    rope_package = (os.path.dirname(sys.modules['rope'].__file__))
+    rope_package = (os.path.dirname(sys.modules['ropeide'].__file__))
     # Checking whether rope is installed or not
     no_project = project.get_no_project()
     if 'docs' in os.listdir(rope_package):
-import os
+import os.path
 import shutil
 import subprocess
 import sys
 
 if __name__ == '__main__':
     for kind in ['rope', 'ropeide', 'ropemacs']:
-        manifest = 'tools/%s_MANIFEST.in' % kind
-        setup = 'tools/%s_setup.py' % kind
+        manifest = os.path.join('tools', '%s_MANIFEST.in' % kind)
+        setup = os.path.join('tools', '%s_setup.py' % kind)
+        readme = os.path.join('docs', '%s.txt' % kind)
         shutil.copy(manifest, 'MANIFEST.in')
         shutil.copy(setup, 'setup.py')
+        shutil.copy(readme, 'README.txt')
         try:
             run_setup(sys.argv[1:])
         finally:
-            for temp in ['setup.py', 'MANIFEST.in', 'MANIFEST']:
+            for temp in ['setup.py', 'MANIFEST.in', 'MANIFEST', 'README.txt']:
                 if os.path.exists(temp):
                     os.remove(temp)

tools/rope_setup.py

       author_email='aligrudi@users.sourceforge.net',
       url='http://rope.sf.net/',
       packages=['rope', 'rope.base', 'rope.base.oi', 'rope.refactor',
-                'rope.refactor.importutils'],
+                'rope.refactor.importutils', 'rope.contrib'],
       license='GNU GPL',
       classifiers=classifiers)

tools/ropeide_MANIFEST.in

-include README.txt COPYING rope.py runtests.py setup.py MANIFEST.in
+include README.txt COPYING rope.py setup.py MANIFEST.in
 include docs/*.html
 include docs/*.txt
 

tools/ropemacs_setup.py

 
 def get_long_description():
     lines = open('README.txt').read().splitlines(False)
-    end = lines.index('Getting Started')
+    end = lines.index('License')
     return '\n' + '\n'.join(lines[:end]) + '\n'
 
 setup(name='ropemacs',
       version='0.1',
       description='An emacs mode for rope refactoring library',
       long_description=get_long_description(),
+      py_modules=['ropemacs'],
       author='Ali Gholami Rudi',
       author_email='aligrudi@users.sourceforge.net',
       url='http://rope.sf.net/',
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.