dpdtrack/README.md

31 lines
785 B
Markdown
Raw Normal View History

2023-08-30 09:33:55 +00:00
# myDPD Python Client
2023-08-16 09:28:38 +00:00
2023-08-30 09:33:55 +00:00
This is a Python client for the myDPD Austria (https://mydpd.at) tracker. It allows you to track your shipments.
2023-08-16 09:28:38 +00:00
2023-08-30 09:33:55 +00:00
It currently *only* supports DPD Austria. If you want to add support for other countries, feel free to open a pull request. Tracking for DPD shipments in other countries *may* work, but it is not guaranteed.
2023-08-16 09:28:38 +00:00
## Installation
```bash
2023-08-30 09:33:55 +00:00
pip install dpdtrack
2023-08-16 09:28:38 +00:00
```
## Usage
```python
2023-08-30 09:33:55 +00:00
from dpdtrack import DPD
2023-08-16 09:28:38 +00:00
2023-08-30 09:33:55 +00:00
api = DPD()
2023-08-16 09:28:38 +00:00
# Realtime tracking
2023-08-24 18:02:51 +00:00
tracking = api.tracking("YOUR_SHIPMENT_NUMBER")
2023-08-30 09:33:55 +00:00
# Optionally pass the recipient's postal code to get more accurate results
tracking = api.tracking("YOUR_SHIPMENT_NUMBER", "RECIPIENT_POSTAL_CODE")
2023-08-16 09:28:38 +00:00
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.