Metadata-Version: 2.1
Name: dhl-express
Version: 0.2.1
Summary: A Python library for interacting with DHL Express API
Home-page: https://github.com/DCDie/dhl-express
Author: Daniel Cuznetov
Author-email: danielcuznetov04@gmail.com
Project-URL: Bug Tracker, https://github.com/DCDie/dhl-express/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown

## Project Description

With *dhl-express*, you can use DHL API to create and manage your shipping labels.

## Requirements

* Python (3.8 or higher)

## Installation

Install using pip

`pip install dhl-express`

## Usage

Use the `DHLService` class to create a new instance of the service.

```python
from dhl_express import DHLService

service = DHLService(
    api_key='YOUR_API_KEY',
    api_secret='YOUR_API_SECRET',
    test_mode=True
)
```

Validate shipment address using the `validate_address` method.

```python
service.validate_address(
    country_code='DE',
    postal_code='12345',
    city='Berlin',
    street='Teststrasse',
    house_number='1'
)
```
Create a shipment using the `create_shipment` method.

```python
service.create_shipment(
    **shipment_data
)
```
Get shipment status using the `get_shipment_status` method.

```python
service.get_shipment_status(
    shipment_id='1234567890'
)
```
Get shipment proof using the `get_shipment_proof` method.

```python
service.get_shipment_proof(
    shipment_id='1234567890'
)
```

## P.S.

If you find bugs, need help, or want to talk to the developers, please write an issue
on [GitHub](https://github.com/DCDie/dhl-express/issues).
