kumi/trackbert
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
34 commits 1 branch 10 tags 189 KiB
Python 98.5%
Mako 1.5%
Find a file
Kumi 23407f031e
Bump version to 0.2.0 and add alembic as a dependency. 
The commit also includes changes to add Alembic configuration file, add migration scripts for initial migration, and modify the database class to include functions for running migrations and creating new migrations.
2023-08-29 10:30:45 +02:00
src/trackbert Bump version to 0.2.0 and add alembic as a dependency. 2023-08-29 10:30:45 +02:00
.gitignore Update .gitignore 2023-08-25 07:44:22 +02:00
.gitlab-ci.yml Making trackbert a proper package 2023-08-25 07:37:43 +02:00
config.dist.ini Add FedEx tracking functionality and configuration to the code 2023-08-27 10:36:30 +02:00
LICENSE Add new files and update existing files with configuration details. 2023-08-18 09:59:40 +02:00
pyproject.toml Bump version to 0.2.0 and add alembic as a dependency. 2023-08-29 10:30:45 +02:00
README.md Update README.md and pyproject.toml 2023-08-27 10:38:11 +02:00

README.md

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

More tracking providers can be added easily by subclassing trackbert.trackers.base.BaseTracker. This should be relatively self-explanatory if you look at the existing implementations. Pull requests are welcome!

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

First, create a virtual environment and install the package:

python -m venv venv
source venv/bin/activate
pip install trackbert

Then create a config.ini in your working directory (see config.dist.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.

You can also omit this step, but then you will only be able to track shipments from Austrian Post and GLS.

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.