Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alufers/paczkobot
A Telgram bot for sending notifications about shipments
https://github.com/alufers/paczkobot
dhl dpd inpost paczkomaty telegram telegram-bot
Last synced: 14 days ago
JSON representation
A Telgram bot for sending notifications about shipments
- Host: GitHub
- URL: https://github.com/alufers/paczkobot
- Owner: alufers
- Created: 2021-02-21T20:58:24.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T19:47:02.000Z (7 months ago)
- Last Synced: 2024-12-25T02:51:20.458Z (about 1 month ago)
- Topics: dhl, dpd, inpost, paczkomaty, telegram, telegram-bot
- Language: Go
- Homepage:
- Size: 799 KB
- Stars: 28
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# paczkobot
A Telegram bot for tracking packages.
See it in action: [@paczko_bot](https://t.me/paczko_bot)
## Features
- [x] Track packages from these providers
- [x] dhl (requires API key)
- [x] ups
- [x] dpd.com.pl
- [x] poczta-polska
- [x] postnl
- [x] Inpost
- [x] gls
- [x] packeta
- [x] FedEx (Poland)
- [x] Geis (Poland)
- [x] Orlen
- [x] Deutsche Post
- Follow packages and send notifications when a package status changes
- Generate QR codes for InPost Paczkomaty
- Automatically import packages from InPost Paczkomaty
- Remotely open InPost Paczkomaty
- Detect package barcodes in images
## Screenshots
## Usage
Create a file called `paczkobot.yaml` looking like this:
```yaml
telegram:
debug: false
username: paczko_bot
token: ""
db:
type: sqlite # or postgres
filename: paczkobot_dev.db # for sqlite
dsn: "host=localhost user=gorm password=gorm dbname=gorm port=9920 sslmode=disable TimeZone=Europe/Warsaw" # for postgres
tracking:
providers:
dhl:
enable: false # register on the dhl developers webpage to enable
api_key: ""
mock:
enable: false
automatic_tracking_check_interval: 20m0s
automatic_tracking_check_jitter: 7m0s
delay_between_packages_in_automatic_tracking: 1m0s
max_packages_per_automatic_tracking_check: 15
max_time_without_change: 336h0m0s
```
You have to enter your telegram token there.
Then you can run the bot as a Go program (`go run .`) or use the following `docker-compose.yml` file to run in docker:
```
version: '3'
services:
paczkobot:
image: ghcr.io/alufers/paczkobot:latest
restart: unless-stopped
volumes:
- ./paczkobot-config.yaml:/etc/paczkobot/paczkobot.yaml
```
Images for x86_64 and aarch64 are provided.
## Contributing
Contributions are welcome! Please open an issue or a pull request.
Please note that this repository uses [pre-commit](https://pre-commit.com/) to run some checks on the code before committing. You can install it with `pip install pre-commit` and then run `pre-commit install` to install the git hooks.
Thank you!