mbarde.signups

Plone-Addon to provide dynamic sign-up forms for events with single or multiple dates / timeslots available.

Originally inspired by https://github.com/collective/uwosh.timeslot (content-type prefixes still come from there):

uwosh.timeslot offers a simple way to allow users of a Plone site to register for events (for example: training sessions or office hours).

Features

• Define date based timeslots users can sign up to
• Logged in users can watch and manage their signups
• Timeslots can have capacities (waiting list and automatically moving up included)
• Timeslots can have effective and expires date (for example to realize registration periods)
• Customizable notification emails
• Dynamically extend signup form with EasyForm (https://github.com/collective/collective.easyform)
• External mail validation via OTP

User states:

1. unconfirmed: Manager has to confirm signup
2. signedup: User is signed up
3. signedoff: User is not signed up
4. waiting: User is on waiting list (moves up when another signup is cancelled)

Signups are locked

It is prohibited to copy or move signups (aka. UTPerson objects) to make sure the intended workflow always takes place to inform users about their booked slots and makes sure that limitations (like the capacity of a slot) are not bypassed.

Dependecies

• https://github.com/collective/collective.easyform

Installation

uv pip install mbarde.signups

Setup

Datasets of signups are identified by the email address of the registrant. So in order to do a proper matching you need to either

• Set Use email address as login name to True in Plone security controlpanel

or

• Create a member property called email

If you want pre-filling of personal data you have to specify corresponding member properties in @@mbarde-signups-controlpanel.

Usage

1. Create UTSignupSheet
2. Add UTDay
3. Add UTTimeslot

Optional: Create EasyForm and set as additional form in UTSignupSheet settings

Important: Ensure MailHost is configured properly (https://docs.plone.org/adapt-and-extend/config/mail.html).

Automatic deletion of personal data

Managers can set "Automatically delete personal data after (days)" for each signup sheet. To have any effect a cronjob needs to be deployed to run purge_expired_persons.py regulary.

For example like this:

0 3 * * * cd /path/to/instance && venv/bin/zconsole run etc/zope.conf venv/bin/mbarde_signups_purge_expired_persons --no-dryrun --site-id Plone

(see [project.scripts] in pyproject.toml)

Contribute

• Issue Tracker: https://github.com/mbarde/mbarde.signups/issues
• Source Code: https://github.com/mbarde/mbarde.signups

Development

Setup

uv venv venv
source venv/bin/activate
uv pip install -e .
uv pip install -r requirements-dev.txt

Test, lint & format

venv/bin/pytest
venv/bin/pytest -k name_of_a_test
venv/bin/black src/
venv/bin/flake8 src/
venv/bin/isort src/

Run a local Plone instance

Create a Zope/Plone instance once (creates instance/, gitignored, with an admin user):

venv/bin/mkwsgiinstance -d instance -u admin:admin

Start it:

venv/bin/runwsgi instance/etc/zope.ini

Then open http://localhost:8080 and use "Create a new Plone site" (log in as admin), adding mbarde.signups (and collective.easyform) as add-ons during site creation, or afterwards via Site Setup > Add-ons.

Set debug-mode on in instance/etc/zope.conf for template auto-reload during development (Python changes still need a restart).

Signups and cancellations send notification emails, which fail locally without a configured SMTP server (ConnectionRefusedError). With debug-mode on and Products.PrintingMailHost installed (part of requirements-dev.txt), outgoing mail is printed to the instance log (instance/var/log/event.log) instead of actually being sent - no local mail server needed.

Update translations

source venv/bin/activate
uv pip install i18ndude
cd src/mbarde/signups/locales
./update.sh

Zope only ever loads compiled .mo catalogs at startup, never the .po source files directly (and .mo files are gitignored, since they're a build artifact). Add this to the <environment> section of instance/etc/zope.conf so a fresh .po is automatically compiled to .mo on every restart - otherwise translations silently keep showing the English text no matter which language is negotiated:

<environment>
  zope_i18n_compile_mo_files true
</environment>

Publish to PyPI

1. Bump version in pyproject.toml (a version can never be uploaded twice), commit and push.
2. Run tests: venv/bin/pytest
3. Build fresh (clear dist/ first, it may contain older versions):

rm -rf dist build src/*.egg-info
uv build
uvx twine check dist/*

4. Upload with an API token from pypi.org (Account settings > API tokens):

uv publish --token pypi-...

5. Tag the release: git tag vX.Y.Z && git push --tags
6. Verify in a clean environment: uv pip install --pre mbarde.signups (--pre is only needed for pre-releases like 1.0.0rc2).

Optional dry run against TestPyPI (separate account and token): uv publish --publish-url https://test.pypi.org/legacy/ --token pypi-...

VS Code setup

Plugins:

• ms-python.black-formatter: Python formatting
• ms-python.flake8: Python linting
• ms-python.vscode-pylance: Python language support
• ms-python.isort: Python imports sorting
• esbenp.prettier-vscode: .html/.pt/.md formatting
• redhat.vscode-xml: .xml formatting

Settings:

{
  "[markdown]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[html]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter"
  },
  "editor.formatOnSave": true,
  "files.associations": {
    "*.pt": "html",
    "*.zcml": "xml"
  },
  "editor.codeActionsOnSave": {
    "source.organizeImports": "always"
  }
}

License

The project is licensed under the GPLv2, see LICENSE.GPL.

AI Usage

Parts of this addon were developed with assistance from Claude Code, Anthropic's agentic coding CLI, using the Claude Sonnet 5 model. The tool was used interactively under human direction and review.