glsapi/README.md

29 lines
603 B
Markdown
Raw Normal View History

2023-08-24 18:02:51 +00:00
# GLS REST API Python Client
2023-08-16 09:28:38 +00:00
2023-08-24 18:02:51 +00:00
This is a Python client for the GLS (https://gls-group.eu) REST API. It allows you to track your shipments.
2023-08-16 09:28:38 +00:00
2023-08-24 18:02:51 +00:00
It currently only supports package tracking, not any other API endpoints.
2023-08-16 09:28:38 +00:00
## Installation
```bash
2023-08-24 18:02:51 +00:00
pip install git+https://kumig.it/kumitterer/glsapi.git
2023-08-16 09:28:38 +00:00
```
## Usage
```python
2023-08-24 18:02:51 +00:00
from glsapi import GLSAPI
2023-08-16 09:28:38 +00:00
2023-08-24 18:02:51 +00:00
api = GLSAPI()
2023-08-16 09:28:38 +00:00
carrier_options = api.detect_carrier("YOUR_SHIPMENT_NUMBER")
# Realtime tracking
2023-08-24 18:02:51 +00:00
tracking = api.tracking("YOUR_SHIPMENT_NUMBER")
2023-08-16 09:28:38 +00:00
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.