pretix-parentduties 0.3.0__tar.gz

pretix_parentduties-0.3.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 JuKi Schömberg e.V.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pretix_parentduties-0.3.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: pretix-parentduties
+Version: 0.3.0
+Summary: pretix plugin: parent duty sign-up during checkout
+Home-page: https://github.com/juki-schoemberg/pretix-parentduties
+Author: JuKi Schömberg e.V.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/juki-schoemberg/pretix-parentduties
+Project-URL: Repository, https://github.com/juki-schoemberg/pretix-parentduties
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-django; extra == "test"
+Provides-Extra: reports
+Requires-Dist: pretix-custom-reports; extra == "reports"
+Dynamic: license-file
+
+# pretix-parentduties
+
+A plugin for [pretix](https://pretix.eu) that lets families commit to a
+**parent duty** (set-up, tear-down, baking a cake …) right in the checkout –
+exactly once per family and event, no matter how many children or orders.
+In the German interface it is called **„Elterndienste“**.
+
+[![License](https://img.shields.io/github/license/juki-schoemberg/pretix-parentduties)](LICENSE)
+
+The full concept (German) is in [`docs/KONZEPT.md`](docs/KONZEPT.md).
+
+## Features
+
+- **Duty slots per event** with name, description, category, date, time,
+  capacity (empty = unlimited), sort position and optional product limit.
+  One-click *duplicate*, so five cake days are set up in a minute.
+- **Checkout step** after the questions and before payment. Full slots are
+  visible but disabled. Optional: several duties per family, “we cannot help”
+  (with or without reason), “decide later”, helper name / phone (off,
+  optional or required), commitment checkbox on the confirmation page.
+  Works in the pretix widget as well.
+- **Per product switch** “triggers the parent duty”, both on the product page
+  and as an overview in the plugin. Default for new products: off.
+- **One duty per family:** automatic match by normalized e-mail address,
+  fallback via the order code of a sibling (followed to the root). Unknown
+  codes never block the checkout – they land in the review list.
+- **Lifecycle:** cancel / expire frees the spot and sends dependent sibling
+  signups to review; reactivation checks capacity; split orders are covered by
+  the original; changed orders without triggering product go to review; test
+  mode deletions clean up; event copy takes slots (without signups, dates
+  cleared) and product switches along; data shredder clears helper data.
+- **Capacity check** on display, on order submission (`validate_order`,
+  parents are sent back to the step) and on signup creation under a row lock.
+  The rare overbooking is saved as *needs review* and triggers a pretix
+  notification.
+- **Backend:** slot list with occupancy bars, signup list with filters
+  (duty, category, status, type, order, “under review / cannot help”), move /
+  exempt / confirm / cancel / link to family / unlink, manual add, order
+  detail box, dashboard widget, settings tab, own permission
+  “Parent duties” (view / change). All changes are logged.
+- **Placeholders** for e-mails and all other pretix texts, plus the same
+  values as ticket/badge layout variables:
+  `{parent_duty}`, `{parent_duty_all}`, `{parent_duty_name}`,
+  `{parent_duty_description}`, `{parent_duty_category}`, `{parent_duty_date}`,
+  `{parent_duty_time_from}`, `{parent_duty_time_to}`, `{parent_duty_time}`,
+  `{parent_duty_helper_name}`, `{parent_duty_helper_phone}`,
+  `{parent_duty_status}`, `{parent_duty_family_code}`, `{parent_duty_note}`,
+  `{parent_duty_url}`, `{parent_duty_waitlist}`, `{parent_duty_free_spots}`,
+  `{parent_duty_open_slots}`.
+- **Self-service change and deeplink:** `{parent_duty_url}` is a secret link
+  (no login) to the parents' duty page, also linked from the order page.
+  Until a configurable deadline (absolute or relative to the event, e.g.
+  “7 days before”) parents can switch to another duty with free spots and
+  update helper name / phone. Withdrawing is not possible; after the deadline
+  the page is read-only. Siblings change at the family's root order,
+  exemptions stay admin decisions.
+- **Waitlist for full duties** (setting: off / notify / move automatically).
+  Families keep their duty and can additionally wait for a full one – in the
+  checkout or later on their duty page. When a spot becomes free (cancellation,
+  change, admin move, more capacity), the longest waiting family is notified
+  by e-mail or moved automatically; spots freed by a move are passed on in
+  turn. Both e-mail texts are editable. Backend list with remove action,
+  waiting count in the slot list and dashboard, `{parent_duty_waitlist}`.
+- **Reminder e-mail:** one click in the settings creates a ready-made scheduled
+  e-mail (pretix “Send out emails” module), e.g. 7 days before the event, for
+  all orders with products that trigger the duty – with `{parent_duty}`,
+  `{parent_duty_description}` and `{parent_duty_url}`.
+- **Report fields** for [pretix-reportgenerator](https://github.com/juki-schoemberg/pretix-reportgenerator)
+  (`plugin.pretix_parentduties.*`), only if it is installed, plus ready-made
+  report templates in [`docs/reports/`](docs/reports/): “Helferliste je Tag” and
+  “Familien in Klärung” (import them via the report generator's JSON import).
+- **REST API** for slots, signups and the waitlist, see [`docs/API.md`](docs/API.md);
+  signups are also included in the order's `plugin_data`.
+
+## Installation
+
+```bash
+pip install pretix-parentduties
+python -m pretix migrate
+python -m pretix rebuild
+```
+
+Then enable “Parent Duties” in the event's plugin settings, create duty slots,
+choose the products that trigger the duty and finally switch on
+**Settings → Parent duties → Checkout step live**.
+
+## Development
+
+```bash
+pip install pretix -e ".[test]"
+cd pretix_parentduties && django-admin compilemessages && cd ..
+pytest
+```
+
+Tests run against the latest pretix stable and (allowed to fail) pretix
+`master`, see `.github/workflows/tests.yml`.
+
+Source strings are English; German (`de`) and English (`en`) catalogs are
+included. Update them with `django-admin makemessages -l de -l en` inside
+`pretix_parentduties/`, then `django-admin compilemessages`. The compiled
+`.mo` files are committed so `pip install git+…` works without a build step.
+
+## Release process
+
+Releases are published to PyPI via a GitHub Actions workflow
+(`.github/workflows/release.yml`) using
+[PyPI Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC,
+no API token stored in the repo). To cut a release:
+
+1. Bump the version in `pyproject.toml` **and** `pretix_parentduties/__init__.py`
+   and commit.
+2. Create and publish a GitHub Release (tag it, e.g. `v0.4.0`). Publishing
+   the release triggers the workflow, which compiles the translations, builds
+   the sdist/wheel and uploads them to PyPI via the `pypi` environment.
+
+The trusted publisher on PyPI is configured for this exact repository
+(`juki-schoemberg/pretix-parentduties`), workflow (`release.yml`), and
+environment (`pypi`) -- publishing only succeeds from that combination.
+
+## License
+
+Apache-2.0, © JuKi Schömberg e.V.

pretix_parentduties-0.3.0/README.md

@@ -0,0 +1,122 @@
+# pretix-parentduties
+
+A plugin for [pretix](https://pretix.eu) that lets families commit to a
+**parent duty** (set-up, tear-down, baking a cake …) right in the checkout –
+exactly once per family and event, no matter how many children or orders.
+In the German interface it is called **„Elterndienste“**.
+
+[![License](https://img.shields.io/github/license/juki-schoemberg/pretix-parentduties)](LICENSE)
+
+The full concept (German) is in [`docs/KONZEPT.md`](docs/KONZEPT.md).
+
+## Features
+
+- **Duty slots per event** with name, description, category, date, time,
+  capacity (empty = unlimited), sort position and optional product limit.
+  One-click *duplicate*, so five cake days are set up in a minute.
+- **Checkout step** after the questions and before payment. Full slots are
+  visible but disabled. Optional: several duties per family, “we cannot help”
+  (with or without reason), “decide later”, helper name / phone (off,
+  optional or required), commitment checkbox on the confirmation page.
+  Works in the pretix widget as well.
+- **Per product switch** “triggers the parent duty”, both on the product page
+  and as an overview in the plugin. Default for new products: off.
+- **One duty per family:** automatic match by normalized e-mail address,
+  fallback via the order code of a sibling (followed to the root). Unknown
+  codes never block the checkout – they land in the review list.
+- **Lifecycle:** cancel / expire frees the spot and sends dependent sibling
+  signups to review; reactivation checks capacity; split orders are covered by
+  the original; changed orders without triggering product go to review; test
+  mode deletions clean up; event copy takes slots (without signups, dates
+  cleared) and product switches along; data shredder clears helper data.
+- **Capacity check** on display, on order submission (`validate_order`,
+  parents are sent back to the step) and on signup creation under a row lock.
+  The rare overbooking is saved as *needs review* and triggers a pretix
+  notification.
+- **Backend:** slot list with occupancy bars, signup list with filters
+  (duty, category, status, type, order, “under review / cannot help”), move /
+  exempt / confirm / cancel / link to family / unlink, manual add, order
+  detail box, dashboard widget, settings tab, own permission
+  “Parent duties” (view / change). All changes are logged.
+- **Placeholders** for e-mails and all other pretix texts, plus the same
+  values as ticket/badge layout variables:
+  `{parent_duty}`, `{parent_duty_all}`, `{parent_duty_name}`,
+  `{parent_duty_description}`, `{parent_duty_category}`, `{parent_duty_date}`,
+  `{parent_duty_time_from}`, `{parent_duty_time_to}`, `{parent_duty_time}`,
+  `{parent_duty_helper_name}`, `{parent_duty_helper_phone}`,
+  `{parent_duty_status}`, `{parent_duty_family_code}`, `{parent_duty_note}`,
+  `{parent_duty_url}`, `{parent_duty_waitlist}`, `{parent_duty_free_spots}`,
+  `{parent_duty_open_slots}`.
+- **Self-service change and deeplink:** `{parent_duty_url}` is a secret link
+  (no login) to the parents' duty page, also linked from the order page.
+  Until a configurable deadline (absolute or relative to the event, e.g.
+  “7 days before”) parents can switch to another duty with free spots and
+  update helper name / phone. Withdrawing is not possible; after the deadline
+  the page is read-only. Siblings change at the family's root order,
+  exemptions stay admin decisions.
+- **Waitlist for full duties** (setting: off / notify / move automatically).
+  Families keep their duty and can additionally wait for a full one – in the
+  checkout or later on their duty page. When a spot becomes free (cancellation,
+  change, admin move, more capacity), the longest waiting family is notified
+  by e-mail or moved automatically; spots freed by a move are passed on in
+  turn. Both e-mail texts are editable. Backend list with remove action,
+  waiting count in the slot list and dashboard, `{parent_duty_waitlist}`.
+- **Reminder e-mail:** one click in the settings creates a ready-made scheduled
+  e-mail (pretix “Send out emails” module), e.g. 7 days before the event, for
+  all orders with products that trigger the duty – with `{parent_duty}`,
+  `{parent_duty_description}` and `{parent_duty_url}`.
+- **Report fields** for [pretix-reportgenerator](https://github.com/juki-schoemberg/pretix-reportgenerator)
+  (`plugin.pretix_parentduties.*`), only if it is installed, plus ready-made
+  report templates in [`docs/reports/`](docs/reports/): “Helferliste je Tag” and
+  “Familien in Klärung” (import them via the report generator's JSON import).
+- **REST API** for slots, signups and the waitlist, see [`docs/API.md`](docs/API.md);
+  signups are also included in the order's `plugin_data`.
+
+## Installation
+
+```bash
+pip install pretix-parentduties
+python -m pretix migrate
+python -m pretix rebuild
+```
+
+Then enable “Parent Duties” in the event's plugin settings, create duty slots,
+choose the products that trigger the duty and finally switch on
+**Settings → Parent duties → Checkout step live**.
+
+## Development
+
+```bash
+pip install pretix -e ".[test]"
+cd pretix_parentduties && django-admin compilemessages && cd ..
+pytest
+```
+
+Tests run against the latest pretix stable and (allowed to fail) pretix
+`master`, see `.github/workflows/tests.yml`.
+
+Source strings are English; German (`de`) and English (`en`) catalogs are
+included. Update them with `django-admin makemessages -l de -l en` inside
+`pretix_parentduties/`, then `django-admin compilemessages`. The compiled
+`.mo` files are committed so `pip install git+…` works without a build step.
+
+## Release process
+
+Releases are published to PyPI via a GitHub Actions workflow
+(`.github/workflows/release.yml`) using
+[PyPI Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC,
+no API token stored in the repo). To cut a release:
+
+1. Bump the version in `pyproject.toml` **and** `pretix_parentduties/__init__.py`
+   and commit.
+2. Create and publish a GitHub Release (tag it, e.g. `v0.4.0`). Publishing
+   the release triggers the workflow, which compiles the translations, builds
+   the sdist/wheel and uploads them to PyPI via the `pypi` environment.
+
+The trusted publisher on PyPI is configured for this exact repository
+(`juki-schoemberg/pretix-parentduties`), workflow (`release.yml`), and
+environment (`pypi`) -- publishing only succeeds from that combination.
+
+## License
+
+Apache-2.0, © JuKi Schömberg e.V.

pretix_parentduties-0.3.0/pretix_parentduties/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.0"