@@ -3,3 +3,5 @@ include AUTHORS include pysmell.vim include pysmell.el include CHANGELOG +include PySmell.tmbundle/** +include PySmell.tmbundle/Commands/** MANIFEST.in @@ -6,17 +6,17 @@ It tries to statically analyze Python source code, without executing it, and generates information about a project's structure that IDE tools can use. -The first target is Vim, because that's what I'm using and because its -completion mechanism is very straightforward. +There is currently support for Vim, Emacs and TextMate. Feel free to contribute +your own favourite editor bindings, or to improve the existing ones. ##Download and Installation PySmell is available at [PyPI](http://pypi.python.org/pypi/pysmell). The best way to install PySmell is by downloading the source distribution and doing `python setup.py install`. While `easy_install pysmell` also works, I haven't -yet found a way of distributing the vim script with it (suggestions welcome). +yet found a way of distributing the editor scripts with it (suggestions welcome). -You be able to `import pysmell` inside your Python interpreter and invoke +You should be able to `import pysmell` inside your Python interpreter and invoke `pysmell` at the command line. You can track the development of PySmell by visiting @@ -26,7 +26,7 @@ develop` will setup your enviroment. ##Usage -To generate a PYSMELLTAGS file, use: +Before you invoke PySmell, you need to generate a PYSMELLTAGS file: cd /root/of/project pysmell . @@ -95,6 +95,15 @@ into the report. Double-click PySmell.tmbundle :) +Complete with alt-esc - look into the bundle for more commands. + +You can find the bundle in the source distribution - it's not installed +with the egg, because it's too much trouble. + +One usual problem you might face is when you install PySmell on a different Python +than your editor uses. Setting the PATH in TextMate's preferences to what is +your normal $PATH resolves this. + ##Emacs Put pysmell.el into your `load-path`, and inside your .emacs file put: @@ -102,7 +111,12 @@ Put pysmell.el into your `load-path`, and inside your .emacs file put: (require 'pysmell) (add-hook 'python-mode-hook (lambda () (pysmell-mode 1))) +Complete with M-/, create tags with M-x pysmell-make-tags + +[Pymacs](http://pymacs.progiciels-bpi.ca/) is required as well. + ##Reporting issues + PySmell is hosted at [Google Code](http://code.google.com/p/pysmell). Look in the [issues list](http://code.google.com/p/pysmell/issues) first. README.markdown @@ -8,4 +8,4 @@ # Released subject to the BSD License -__version__ = "0.7a" +__version__ = "0.7" pysmell/__init__.py 5c776b4ab08cf6060892a589a20692446a46173b Orestis Markou orestis@orestis.gr http://github.com/orestis/pysmell/commit/6b4e3f55f2d0eb6ade3311fdf676f86cdcbe55d8 6b4e3f55f2d0eb6ade3311fdf676f86cdcbe55d8 2008-10-30T18:29:00-07:00 2008-10-30T18:29:00-07:00 Documentation update and version bump d14610f08e14c95c16e2db6ff8ef7de803e38e29 Orestis Markou orestis@orestis.gr