Skip to main content

issues open license GPL last commit top language repo size Code style: black Code style: pycodestyle pre-commit

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

Metadata

Release files for pymkup 0.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pymkup 0.8
File Size Uploaded Provenance Actions
pymkup-0.8.tar.gz 9.7 kB Without provenance Details for pymkup-0.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pymkup 0.8
File Interpreter ABI Platform Actions
pymkup-0.8-py3-none-any.whl Python 3 none any Details for pymkup-0.8-py3-none-any.whl

Total release size: 18.8 kB

Release files / pymkup-0.8.tar.gz

Download URL pymkup-0.8.tar.gz
Size 9.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a95f366b245bcaca16200c75686f1b43e8b3fd8b7cddc8024131da7a99918bd1
BLAKE2b-256 checksum
How to use checksums
0b5ee051deb17d405a1cbb6b500a31affe2a07ffa105478a49843da08e0106c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.6

Release files / pymkup-0.8-py3-none-any.whl

Download URL pymkup-0.8-py3-none-any.whl
Size 9.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
41da02a5844bb8a3fa349d431780fbd7a1fcc264fd38f294da065fdf3d664638
BLAKE2b-256 checksum
How to use checksums
97ba72de40dc71be300702e4e2430d885c764a6536cb5b26be2b1696eca853c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.6

Security for pymkup 0.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page