WinAppDbg is released under the BSD license, so as a user you are entitled to create derivative work and redistribute it if you wish. A batch script is provided to automatically generate the source distribution package and the Windows installer, and can also generate the documentation for all the modules using Epydoc and Sphinx.
The distribution building requires Python 2.7 as a minimum version. It works both with 32 and 64 bits. Older versions of Python will fail. The 32 bits interpreter is expected to be installed at %SystemDrive%Python27 and the 64 bits version at %SystemDrive%Python27-x64. If both are found the 64 bits version is used.
This documentation was generated using Sphinx. The reStructuredText sources are provided with the source code downloads only.
A Latex compiler is used to generate the documentation in PDF format. We’re currently using MikTex 2.7 on Windows.
The HTML help can be compiled to a .CHM file using Microsoft HTML Help Workshop.
The Make utility is used to run makefiles, and the Tar, GZip and BZip2 utilities are required to compress .tar.gz and .tar.bz2 files. We’re using Cygwin because the packages from GnuWin32 suffer from really nasty bugs (most notably the Tar command tries to call fork() on Windows...).
All of these tools must be present in the PATH environment variable.
The decorator module is also recommended since it integrates better than the built-in decorators with the autodoc tools we’re using. You can install it with easy_install or download it from the Python Package Index.
Both the source code and Windows installer packages are generated with Distutils, which is already shipped with your Python distribution. The setup.py file is the installer script that contains the package metadata and the list of files to include.
You can find more information on Distutils installer scripts here.
An install batch file (install.bat) is provided for convenience when installing WinAppDbg in multiple versions of Python coexisting in the same machine.
A batch file (distro.bat) is provided to build the packages. These are the commands it supports:
Generates the all documentation and builds all the packages.
Removes all files and directories created by the other make commands.
Builds only the source code packages in zip and tar.bz2 format.
Builds only the Windows installer packages (that is, the exe and msi files) for all supported platforms and architectures.
Generates only the reference documentation using Epydoc.
Generates only the manuals using Sphinx.
This is the directory structure expected for the makefile and the install script to work.
This folder contains the reStructured text for the manuals. It’s included only in the source distribution package.
This folder contains the example scripts shipped with WinAppDbg. They’re the same examples found in the project wiki pages. It’s included only in the source distribution package.
This folder contains the utility scripts shipped with WinAppDbg. It’s included in both the source distribution package and the Windows installer.
This folder contains the WinAppDbg source code itself. It’s included in both the source distribution package and the Windows installer.
Temporary folder created when building the source distribution and Windows installer. You can safely delete this.
This is where the source distribution and the Windows installer files are stored.
This folder contains the compiled manuals in HTML and PDF formats.
This is where the reference documentation files are stored, in HTML format. If you compile this documentation into a .CHM file it’ll also be stored here.
This is where the reference documentation files are stored, in PDF and PostScript format.