From 649e40cae91908d8c26bd53286c3ed2d71b0304b Mon Sep 17 00:00:00 2001 From: takunomi-build-bot Date: Wed, 22 Jan 2025 22:43:39 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Repository=20layout=20updated=20?= =?UTF-8?q?to=20latest=20version?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager --- README.md | 13 +++++++++++-- setup.py | 15 ++++++++++++--- 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b34a55f..7aa0b21 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,18 @@ ![Test program/library](https://gitfub.space/Jmaa/package-tracking/actions/workflows/python-test.yml/badge.svg) -Sample package tracking website. +Small alternative frontend for tracking packages and parcels. -Use the [Parcels API](https://parcelsapp.com/). +Use the excellent [Parcels App API](https://parcelsapp.com/), and thus requires +an API key. + +This was written specifically for embedding as an iframe into homepage +applications like [Homepage](https://gethomepage.dev/) or [Dashy](https://dashy.to/). + +Once run, it exposes the following endpoints: + +- `/`: Base view, including a form for adding new parcels. +- `/noninteraction`: Smaller view for embedding as iframe. ## Dependencies diff --git a/setup.py b/setup.py index e7e3048..4becf64 100644 --- a/setup.py +++ b/setup.py @@ -13,13 +13,22 @@ PACKAGE_NAME = 'package_tracking' PACKAGE_DESCRIPTION = """ # Package-tracking. -Sample package tracking website. +Small alternative frontend for tracking packages and parcels. -Use the [Parcels API](https://parcelsapp.com/). +Use the excellent [Parcels App API](https://parcelsapp.com/), and thus requires +an API key. + +This was written specifically for embedding as an iframe into homepage +applications like [Homepage](https://gethomepage.dev/) or [Dashy](https://dashy.to/). + +Once run, it exposes the following endpoints: + +- `/`: Base view, including a form for adding new parcels. +- `/noninteraction`: Smaller view for embedding as iframe. """.strip() PACKAGE_DESCRIPTION_SHORT = """ -Sample package tracking website.""".strip() +Small alternative frontend for tracking packages and parcels.""".strip() def parse_version_file(text: str) -> str: