pymkup 0.8

Accessing Bluebeam Revu PDF Data

pymkup

pymkup is a Python library for viewing markups lists and property data in PDFs created by Bluebeam Revu.

About

This is a reverse-engineered unofficial API for accessing data generated in Bluebeam Revu authored PDFs. Once a file is loaded, it can be scraped for some information.

Installation

Use the package manager pip to install pymkup.

pip install pymkup

Usage

from pymkup import Pymkup
x = Pymkup("link to your Revu PDF")
x.spaces()  # Returns JSON dictionary of document spaces.
x.markups()  # Returns JSON dictionary of markups.

Data export with custom columns example

First, you should identify the columns that are accessible in your file:

x.get_columns().values()

Second, you should review the extended columns that can also be added:

x.extended_columns()

Lastly, you can build the custom columns that you want to see returned:

columns = ['Subject', 'Label', 'Date', 'UUID', 'Space']
x.markups(column_list=columns)

Requirements

• pdfreader for browsing the PDF tree.
• matplotlib to build Spaces, convert colors.
• tox to run virtualenv tests.
• pytest for unit testing.

Dev Testing

pip install tox

Once installed, run 'tox' from project root directory, and it will run unit tests on multiple python installation. Tests are files within the /test folder.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT