No description

Find a file

Kumi c12572430f Add new files and update existing files with configuration details. - Added LICENSE file with MIT license details. - Added README.md file with information on how to use the script. - Added config.dist.ini file with KeyDelivery API configuration details.		2023-08-18 09:59:40 +02:00
.gitignore	Current status	2023-08-17 12:50:49 +02:00
config.dist.ini	Add new files and update existing files with configuration details.	2023-08-18 09:59:40 +02:00
LICENSE	Add new files and update existing files with configuration details.	2023-08-18 09:59:40 +02:00
README.md	Add new files and update existing files with configuration details.	2023-08-18 09:59:40 +02:00
requirements.txt	Current status	2023-08-17 12:50:49 +02:00
trackbert.py	chore: Add docstrings to all functions	2023-08-18 09:38:18 +02:00

README.md

Trackbert

A simple Python script for tracking shipments through KeyDelivery.

If your system provides notify-send, you will get a desktop notification when the status of your shipment changes.

Status information is stored in a SQLite database.

Requirements

The script was developed and tested on Arch Linux using Python 3.11. The "Never" type hint is used, so I suppose it will not work on older Python versions. It should work on any Linux distribution. You can technically run it on Windows and macOS as well, but you will not get desktop notifications.

In order to get desktop notifications, you need to have notify-send installed. On Arch Linux, this is provided by the libnotify package. If your desktop environment does not provide a notification server, you have to install one yourself. How to do this is beyond the scope of this README.

Installation

git clone https://kumig.it/kumitterer/trackbert.git
cd trackbert
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Then copy config.dist.ini to config.ini and fill in your KeyDelivery API details, which you can find in your KeyDelivery API management. You can find your API key in your KeyDelivery account settings.

Usage

To add a new shipment, run python trackbert.py --tracking-number <tracking-number> --carrier <carrier-id>. Find the required carrier ID in the KeyDelivery API management.

To run the main loop, run python trackbert.py. This will check the status of all shipments every 5 minutes, and print the status to the console. If the status of a shipment changes, you will get a desktop notification.

License

This project is licensed under the MIT License. See the LICENSE file for details.