Skip to content
obeattie edited this page Sep 13, 2010 · 10 revisions

pdfminer documentation

This wiki is an attempt at documenting the as yet undocumented API of pdfminer. Beyond what is in docs/index.html, there appears to be no solid API documentation. As a developer new to pdfminer (like me), this is definitely frustrating when your use-case is outside the scope of what can be achieved with the sole use of the scripts in tools/.

Please note that this is still a definite work in progress. Large chunks of the codebase are (as yet), undocumented. As I learn more about the library, I will document its components to the best of my ability as I go. Also of note note is that I’m not guaranteeing that what I’m saying is accurate (though I do try); it’s what I make of it from reading the code. If you know that what I’ve written on a particular topic is totally (or even slightly) off-base, then feel free to let me know, so I can correct it.

Module-level documentation

“Other” documentation

  • Tools: Documentation for tools in the tools/ directory.