Metadata-Version: 2.1
Name: pydpd
Version: 0.1.4.10
Summary: DPD API Wrapper
Home-page: https://github.com/lewis-morris/pydpd
Author: Lewis Morris
Author-email: lewis.morris@gmail.com
License: MIT
Description: # pydpd
        
        ## A DPD API wrapper (UK only)
        
        Create DPD shipments and generate parcel labels from within your application or webapp.
        
        You will need a valid DPD account and have API access enabled (which can be done by calling 0121 275 7336)
        
        ## Features
        
        * Check available services for a shipment
        * Create a shipment 
        * Generate labels in HTML, PDF, PNG or the raw printer data
        
        ## What's not possible
        
        * Collections
        * Swaps
        * Extended Liability   
        * Internation Shipments
        
        
        ## Installation
        
        Download and install can be done through PyPi
        
        ```
        pip install pydpd
        ```
        or
        
        ```python
        git clone https://github.com/lewis-morris/pydpd
        cd pydpd
        pip install -e .
        ```
        
        ## IMPORTANT NOTE
        If you want to generate PDF or PNG versions of your labels you will have to install some additional software
        
        ### Linux / Ubuntu
         sudo apt-get install wkhtmltopdf
        
         sudo apt-get install wkhtmltoimage
        ### Windows
         [Windows installer download](https://wkhtmltopdf.org/downloads.html)
        
         When installing wkhtmltopdf and wkhtmltoimage on windows you need to set an environment variable to point to the wkhtmltopdf or wkhtmltoimage executable. 
         You should be able to find extensive documentation to this online, but I won't provide a link to this to avoid dead links etc.
        
        
        ## Pending Features
        
        * Parcel Tracking 
        
        ## How to use
        
        ### Minimal working example
        
        ```python
        from pydpd import DPD, Parcel, Address
        
        #create sender object
        sender = Address(**{"name": "Mr Ship",
                            "organisation": "SuperShipCo",
                            "address1": "Ship Street",
                            "address2": "Shipton",
                            "postcode": "BR5 3DX"})
        #create dpd object
        dpd = DPD("[your dpd username]","[your dpd password]","[your dpd acc no]", sender)
        
        #create a parcel definition
        my_parcel = Parcel(**{"weight": 10,
                                 "pcs": 2,
                                 "name": "Boris",
                                 "address1": "10 Downing Street",
                                 "address2": "London",
                                 "postcode": "SW1A 2AB"})
        
        #book the delivery with "1^12" service - (Next day)  returns a delivery object
        my_delivery = dpd.create_delivery(my_parcel,"1^12")
        
        #get dpd PIL image label
        my_delivery.get_png_labels(2)[0]
        
        ```
        
        ![Image](examples/nVNBt39IzpOmOg.png)
        
        ### Full Example 
        I always find it best to learn by example so follow this jupyter notebook to see the flow. 
        
        [Jupyter notebook examples](examples/dpd_example.ipynb)
        
        All classes have doc strings, so you can always check there if you get stuck.
        
        
        ## Contact
        
        If you have any issues or just want to chat you can always email me at lewis.morris@gmail.com or open an issue.
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
