Skip to main content

Python application tracking your shipments

Project description

Trackbert

A simple Python script for tracking shipments, primarily 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.

Currently supported tracking providers

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 .

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

First, assure that the virtual environment is activated:

source venv/bin/activate

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

To run the main loop, run trackbert. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trackbert-0.1.0.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

trackbert-0.1.0-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file trackbert-0.1.0.tar.gz.

File metadata

  • Download URL: trackbert-0.1.0.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for trackbert-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4444d7ce162138fa46d90374796cb707732f2d2fab003e91e56138015762afcf
MD5 738d13670e5735aafeec934afd8b6baf
BLAKE2b-256 32853fabcea7bb880b674ed58cf0610bc31d6434726f80bd0df1c504d79e5461

See more details on using hashes here.

File details

Details for the file trackbert-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: trackbert-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for trackbert-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 635850618d935311698182a34b8baefc715f145a2ce5841439588c85767abe0b
MD5 0b1fbb13dc6dba28769b44704a5cb86c
BLAKE2b-256 660b1fc249196847b22c41bafbb1aae103f8514230a34d4d263286478553bec0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page