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

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

  • classes and functions exposed by a package (i.e. imported or defined in __init__.py) should show up in the output

  • 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? e.g. func() or “def func()” and “class ClassA” ?)

  • 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.1.zip (5.6 kB view details)

Uploaded Source

File details

Details for the file pyls-0.1.1.zip.

File metadata

  • Download URL: pyls-0.1.1.zip
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyls-0.1.1.zip
Algorithm Hash digest
SHA256 7af21252135ba983a199d5671b432d4a5bef23da9bd14e621faff375488523a3
MD5 77d91faa8345ad816b76b060e8285c25
BLAKE2b-256 41ed701023ed02ff6535af7b00e1a2bda65a3af567c14e96538a56617e3ba836

See more details on using hashes here.

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