rspivak / grok-ipython

IPython profile for Grok.
=========================

This is ipython shell that provides basic commands
for navigating and exploring Grok's ZODB instance.

Inspired by ipy_profile_zope.py distributed with IPython.

Put ipy_profile_grok.py into .ipython directory in your home dir.
Then launch IPython shell from your Grok based project:

$ bin/ipython -p grok

There are several assumptions:

1) You have ipython installed.
   If not - add 'ipython' to eggs directive in your buildout.cfg
   and rerun bin/buildout

2) Your zope.conf is located in parts/etc directory.
   If you use latest grokproject this is by default

In the shell following names are bound:

root - root object in your instance
ctx  - points to current container object, may change over time if
       you, for example, cd into another container

cdg / ;cdg - cd into container with given path.
Examples:
  cdg('/blog/entry')
  cdg /blog/entry  -> you can use auto-completion in this form

lsg / ;lsg - list objects in current container or at given path
Examples:
  lsg
  lsg /blog
  ;lsg /blog/entry -> you can use auto-completion in this form

pwdg - print absolute path to current container

sync - synchronize (manually update the view on the database)

commit - commit changes to database