A python module and command lite utility for publishing windows debugging symbols to symbols store. The symbols published in this format can be consumed by the common development tools for windows, such as Visual Studio and WinDbg. See Using SymStore for more information on windows symbols store.
Currently it is possible to publish PDB and PE (exe and dll) files to a local file system.
Install with pip utility by running:
$ pip install symstore
This will install the command line utility symstore
as well as python module symstore
.
It is also possible to install symstore package from source code. For example, clone symstore's git repository with:
$ git clone <repo-url> symstore
and install it with pip:
$ pip install symstore/
Use the symstore
command to publish the symbols. Run symstore --help
for details.
To publish symbols programmatically use the symstore
module.
See symstore/command_line.py
for an example on how to use the API.
The symstore package supports compressing the data files when publishing them. This can lead to significant reduction of data that needs to be transferred while accessing symbols.
The compression mode is activated with --compress
or -z
flag to symstore
command line utility.
Symstore uses the gcab
library and it's python binding to compress data.
The required packages must be available on the system for the compression mode to work.
In case symstore is not able to locate gcab packages while compression mode is requested, following error message will be displayed:
gcab module not available, compression not supported
- added compression support
- dropped dependency to pdbparse and construct modules
- added support for python 3
- dropped dependency to pefile module
- print nice error message on currupt PE files