PyFlag Developer documentation

This is the developer documentation for pyflag. This document is designed to assist programmers to develop forensic or database applications using the pyflag framework.

The following document has many examples of using the various classes. The author prefers to use the ipython shell to test things out. Before using ipyton, the python path must be set to load pyflag classes:

cd pyflag
export PYTHONPATH=`pwd`:`pwd`/libs/
ipython

The manual is divided into the following broad categories in approximate order of complexity. It is expected that readers cover earlier categories prior to reading later categories:

• Utility classes. These classes assist in performing simple, common tasks.

• Extending PyFlag. This section covers the plugin architecture and explains how to construct new plugins. Plugins can be new reports, virtual filesystem drivers and scanners.