plain 0.39.0__py3-none-any.whl → 0.39.1__py3-none-any.whl

plain/chores/README.md

@@ -0,0 +1,64 @@
+# Chores
+
+**Routine maintenance tasks.**
+
+Chores are registered functions that can be run at any time to keep an app in a desirable state.
+
+![](https://assets.plainframework.com/docs/plain-chores-run.png)
+
+A good example is the clearing of expired sessions in [`plain.sessions`](/plain-sessions/plain/sessions/chores.py) — since the sessions are stored in the database, occasionally you will want to delete any sessions that are expired and no longer in use.
+
+```python
+# plain/sessions/chores.py
+from plain.chores import register_chore
+from plain.utils import timezone
+
+from .models import Session
+
+
+@register_chore("sessions")
+def clear_expired():
+    """
+    Delete sessions that have expired.
+    """
+    result = Session.objects.filter(expires_at__lt=timezone.now()).delete()
+    return f"{result[0]} expired sessions deleted"
+```
+
+## Running chores
+
+The `plain chores run` command will execute all registered chores. When and how to run this is up to the user, but running them hourly is a safe assumption in most cases (assuming you have any chores — `plain chores list`).
+
+There are several ways you can run chores depending on your needs:
+
+- on deploy
+- as a [`plain.worker` scheduled job](/plain-worker/plain/worker/README.md#scheduled-jobs)
+- as a cron job (using any cron-like system where your app is hosted)
+- manually as needed
+
+## Writing chores
+
+A chore is a function decorated with `@register_chore(chore_group_name)`. It can write a description as a docstring, and it can return a value that will be printed when the chore is run.
+
+```python
+# app/chores.py
+from plain.chores import register_chore
+
+
+@register_chore("app")
+def chore_name():
+    """
+    A chore description can go here
+    """
+    # Do a thing!
+    return "We did it!"
+```
+
+A good chore is:
+
+- Fast
+- Idempotent
+- Recurring
+- Stateless
+
+If chores are written in `app/chores.py` or `{pkg}/chores.py`, then they will be imported automatically and registered.

{plain-0.39.0.dist-info → plain-0.39.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain
-Version: 0.39.0
+Version: 0.39.1
 Summary: A web framework for building products with Python.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE

{plain-0.39.0.dist-info → plain-0.39.1.dist-info}/RECORD

@@ -14,6 +14,7 @@ plain/assets/finders.py,sha256=2k8QZAbfUbc1LykxbzdazTSB6xNxJZnsZaGhWbSFZZs,1452
 plain/assets/fingerprints.py,sha256=2LPHLUkoITMseLDmemTpBtMRDWCR2H5GAHjC6AN4gz0,1367
 plain/assets/urls.py,sha256=zQUA8bAlh9qVqskPJJrqWd9DjvetOi5jPSqy4vUX0J4,1161
 plain/assets/views.py,sha256=T_0Qh6v9qBerEBYbhToigwOzsij-x1z_R-1zETQcIh0,9447
+plain/chores/README.md,sha256=Da8Nw8ZF7PlAE_iVb0AqJGbLOu0F6HC0cj1K451KBak,1946
 plain/chores/__init__.py,sha256=r9TXtQCH-VbvfnIJ5F8FxgQC35GRWFOfmMZN3q9niLg,67
 plain/chores/registry.py,sha256=V3WjuekRI22LFvJbqSkUXQtiOtuE2ZK8gKV1TRvxRUI,1866
 plain/cli/README.md,sha256=ompPcgzY2Fdpm579ITmCpFIaZIsiXYbfD61mqkq312M,1860
@@ -145,8 +146,8 @@ plain/views/forms.py,sha256=ESZOXuo6IeYixp1RZvPb94KplkowRiwO2eGJCM6zJI0,2400
 plain/views/objects.py,sha256=GGbcfg_9fPZ-PiaBwIHG2e__8GfWDR7JQtQ15wTyiHg,5970
 plain/views/redirect.py,sha256=vMXx8430FtyKcT0V0gyY92SkLtyULBX52KhX4eu4gEA,1985
 plain/views/templates.py,sha256=kMcHKkKNvucF91SFGkaq-ugjrCwn4zJBpFV1JkwA544,2027
-plain-0.39.0.dist-info/METADATA,sha256=DlIAs31jS4S87R0UhAlZlYdgxZGKOebjo3IcgK5yas4,4297
-plain-0.39.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain-0.39.0.dist-info/entry_points.txt,sha256=1Ys2lsSeMepD1vz8RSrJopna0RQfUd951vYvCRsvl6A,45
-plain-0.39.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
-plain-0.39.0.dist-info/RECORD,,
+plain-0.39.1.dist-info/METADATA,sha256=e8tEYf656PoEDJU624eCgDYMAT9_Jc1ewukJa45-_7g,4297
+plain-0.39.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain-0.39.1.dist-info/entry_points.txt,sha256=1Ys2lsSeMepD1vz8RSrJopna0RQfUd951vYvCRsvl6A,45
+plain-0.39.1.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
+plain-0.39.1.dist-info/RECORD,,