Metadata-Version: 2.1
Name: pymkup
Version: 0.6
Summary: Accessing Bluebeam Revu PDF Data
Home-page: https://github.com/psolin/pymkup
Author: Paul Solin
Author-email: paulsolin@gmail.com
License: MIT
Description: <p align="center">
          <img src="https://img.shields.io/github/issues/psolin/pymkup" alt="issues open"/>
          <img src="https://img.shields.io/github/license/psolin/pymkup" alt="license GPL"/></a>
          <img src="https://img.shields.io/github/last-commit/psolin/pymkup" alt="last commit"/>
          <img src="https://img.shields.io/github/languages/top/psolin/pymkup" alt="top language"/>
          <img src="https://img.shields.io/github/repo-size/psolin/pymkup" alt="repo size"/>
          <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"/></a>
          <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/code_style-pycodestyle-ff69b4.svg?style=flat-square" alt="Code style: pycodestyle"/></a>
          <a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white" alt="pre-commit"/></a>
         </p>
        
        # 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](https://pip.pypa.io/en/stable/) to install pymkup.
        
        ```bash
        pip install pymkup
        ```
        
        ## Usage
        
        ```python
        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:
        ```python
        x.get_columns().values()
        ```
        
        Second, you should review the extended columns here that can also be added:
        ```python
        ['Page Number', 'Page Label', 'Measurement', 'Space']
        ```
        
        Lastly, you can build the custom columns that you want to see returned:
        ```python
        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
        
        ```bash
        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](https://choosealicense.com/licenses/mit/)
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
