Metadata-Version: 2.1
Name: pdfworkshop
Version: 1.0.3
Summary: PDF compressor utility, using iLovePDF API
Home-page: https://github.com/eden-box//pdfworkshop
Author: Eden-Box
Author-email: eden.box@outlook.com
License: MIT
Description: # pdfworkshop
        
        PDF compress tool, using iLovePDF API
        
        ## Prerequisites
        The application is compatible with Windows and Linux based systems.
        Python version 3.5 or above is assumed to be installed, as well as pip package manager utility and setuptools module.
        
        ## Installation
        ```bash
        pip install pdfworkshop
        ``` 
        or
        ```bash
        python setup.py install
        ``` 
        
        ## How to run
        ```bash
        pdfworkshop -h
        ```
        
        ## Configuration
        The public_key value must be defined before using the tool for the first time.
        The required public key can be obtained by creating a developer account in [iLovePDF](https://developer.ilovepdf.com/).
        The value can be configured using:
        ```bash
        pdfworkshop config public_key new_public_key_value
        ``` 
        The input/ouput directories can also be configured, although not advised.
        Their default values are set to the current directory and another _output_ directory,
        according to the path from where the tool was called.
        
        ## Commands
        - list-config - list tool configuration values
        - config \<option\> \<value\> - edit tool configuration values
        - run - compress all PDF files stored in input_dir, storing the result in output_dir
        
        ## How to use
        By default, the PDF files to compress should be on the directory from where the tool will be called.
        After using the _run_ command, an _output_ directory will be created, where all compressed
        files will be stored.
        
        ## Example run
        
        To exercise some of the available commands, one can try to:
        
        - List the current configuration
        ```bash
        pdfworkshop list-config
        ```
        - Define the API public_key value
        ```bash
        pdfworkshop config public_key <new_public_key>
        ```
        - Run PDF compress tool
        ```bash
        pdfworkshop run
        ```
        
        ## License
        
        This project is licensed under the MIT License - see [LICENSE](LICENSE) file for details.
        
Keywords: python pdf compress ilovepdf
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Topic :: Utilities
Classifier: Topic :: Office/Business
Requires-Python: ~=3.5
Description-Content-Type: text/markdown
Provides-Extra: dev
