Skip to main content

List the content and structure of a Python project

Project description

Only tested on Microsoft Windows and Python 2.7
Docs and download: http://pypi.python.org/pypi/pyls
Source code: http://bitbucket.org/tartley/pyls
+----------------------------------------------------------+
| Hey. Does anyone know why my long_description Restructured Text isn't
| working? If I run it through 'rst2html readme.txt >readme.html'
| then it runs fine without errors, but for some reason pypi won't
| eat it, just shows up as plain. Thanks for any pointers.
+----------------------------------------------------------+
Usage
-----
::
pyls [<dir1> [, <dir2>...] ]

Produces a listing of the python project in directly <dir>, or else in the
current directory if none given, in the following format::
package
subpackage
module1.py
ClassA
ClassB
module2.py
ClassC
module3.py
ClassD

Known Issues
------------
Pyls works by importing every module it finds in the given directories, and
enumerating the classes defined by importing that module. If you are doing
anything cleverer than defining static classes in regular modules, then pyls
will probably barf on it.

Todo
----
* Test on Ubuntu
* Pester someone to test on a Mac for me
* Python 3
* accept command line directories specified as relative dirs (e.g. '..')
* List module-level functions too.
* Some way to differentiate classes from functions?
* optional colored output?
* optionally list class methods?
* compact mode, that lists classes in a module on the same line?

Thanks
------
To Susan for putting up with my googly-eyed coding frenzies.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyls-0.1.zip (4.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page