robrechtdr / pykaboo Goto Github PK

Note about usage

Shortly after it's last release I stopped using Pykaboo for what it was intended. At the time I made it I still worked with Gedit as my main editor, need I say more? It is still convenient however in case I would want to print out a significant amount of specific files in a repository.

If you are wondering I now use Vim as my editor and in case I'd want to find only Python files or a file with a specific name I would just use find.

A convenient command line tool to check python source code from the python standard library and user installed packages.

Running Pykaboo opens a new tab in your browser listing your python standard library modules folder and user installed packages folder. New paths can also be added to this list.

When clicking on a .py file, python syntax is highlighted and lines are numbered.

Typical usage:

$ pykaboo

Pykaboo shows only '.py' files and directories by default. But you can also allow files with other extensions to be viewed:

$ pykaboo allow .css

Or you can add custom directories next to the default links to the standard library modules and user installed packages:

$ pykaboo add ~/Documents/my_python_projects

For a list of commands:

$ pykaboo help

First install pip. Then:

$ pip install pykaboo

Use Cygwin or use a Linux distro on a virtual machine.

• Using Cygwin:

  1. Install Cygwin. During the installation, also mark the bins of Python (under Interpreters) and wget (under Web) for installation.

  2. In the Cygwin terminal run the following commands:

     $ wget http://peak.telecommunity.com/dist/ez_setup.py
     $ python ez_setup.py
     $ easy_install pip
     $ pip install pykaboo
     

     To use Pykaboo just run the following command in Cygwin:

     $ pykaboo
     

     In case you get errors, try rebasing Cygwin .

• Using a virtual machine:

  Here you can find a tutorial to install the Linux distro Ubuntu on the virtual box virtual machine. Once installed see the Linux users section.

If you need support or if you spot bugs send a mail to robrecht.de.rouck at gmail.com. If you have a github account opening an issue or making a poll request is appreciated in case of bugs.