Metadata-Version: 2.4
Name: gopromotional-event-planner
Version: 1.0.0
Summary: Event countdown, planning timeline, giveaway quantities and print order-by dates.
Author: GoPromotional
License-Expression: MIT
Project-URL: Homepage, https://www.gopromotional.co.uk/
Project-URL: Repository, https://github.com/nbkdevs/GoPromotional
Project-URL: Issues, https://github.com/nbkdevs/GoPromotional/issues
Keywords: event-planning,countdown,trade-show,giveaways,cli
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: test
Requires-Dist: pytest>=7; extra == "test"
Dynamic: license-file

# gopromotional-event-planner

Plan an event or trade show from the command line or your code: a countdown, a 12-step planning timeline with due dates, an estimate of how many giveaway items to order, and the latest order date for printed merchandise in working days.

- **Countdown** to the event in days, and in weeks + days.
- **Planning timeline**: 12 tasks from 8 weeks out to the post-event follow-up, each with a due date, days left and an overdue flag.
- **Giveaway quantity**: attendees × days × uptake × items per person, plus a buffer, rounded up.
- **Order-by date**: production + delivery + safety margin counted back in working days (Mon–Fri).

## Install

```sh
pip install gopromotional-event-planner
# or, for the CLI only:
pipx install gopromotional-event-planner
```

## Command line

```console
$ gopromotional-event-planner countdown 2026-12-03 --today 2026-10-19
45 days to go (6 weeks 3 days) until 2026-12-03.

$ gopromotional-event-planner giveaways --attendees 500 --days 2 --uptake 0.6
Order 660 items (600 expected + 60 buffer).

$ gopromotional-event-planner order-by 2026-12-03 --today 2026-10-19
Order by 2026-11-12 (15 working days before the event), 24 days from today.

$ gopromotional-event-planner timeline 2026-12-03 --today 2026-10-19
! 2026-10-08  Confirm budget and attendee estimate  (overdue)
! 2026-10-15  Book the venue  (overdue)
  2026-10-22  Order branded merchandise and giveaways
  2026-10-29  Send invitations or open registration
  2026-11-05  Confirm speakers and agenda
...
```

Every command accepts `--json` for machine-readable output. Run `gopromotional-event-planner --help` for all options.

## Library

```python
from gopromotional_event_planner import countdown, giveaway_quantity, order_by_date, timeline

countdown("2026-12-03", today="2026-10-19")["days"]            # 45
giveaway_quantity(500, days=2)                                  # {'base': 600, 'buffer': 60, 'total': 660}
order_by_date("2026-12-03", today="2026-10-19")["order_by"]     # '2026-11-12'
[r["task"] for r in timeline("2026-12-03", today="2026-10-19") if r["overdue"]]
```

Pure Python, no dependencies, Python 3.9+.

## Links

- Website: [GoPromotional](https://www.gopromotional.co.uk/)
- Source code: [https://github.com/nbkdevs/GoPromotional](https://github.com/nbkdevs/GoPromotional) (`packages/homepage/pypi`)
- Licence: MIT
