silencewatch 0.1.0__tar.gz

silencewatch-0.1.0/.gitignore

@@ -0,0 +1,48 @@
+# dependencies
+node_modules/
+.pnp/
+.pnp.js
+
+# build output
+dist/
+build/
+out/
+*.tsbuildinfo
+packages/web/.angular/
+packages/server/public/
+
+# java
+target/
+clients/spring-boot-starter/target/
+
+# environment / secrets — never commit these
+.env
+.env.*
+!.env.example
+*.pem
+*.key
+!**/*.key.example
+
+# logs & runtime
+*.log
+npm-debug.log*
+coverage/
+.nyc_output/
+pgdata/
+
+# editors / os
+.idea/
+.vscode/*
+!.vscode/extensions.json
+.DS_Store
+Thumbs.db
+
+# python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.venv/
+clients/python/dist/

silencewatch-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+The Python library is versioned apart from the application, and tagged
+`python-N.N.N`. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [Unreleased]
+
+## [0.1.0]
+
+First release.
+
+- **Celery beat** and **APScheduler 3** integrations: the jobs are declared to SilenceWatch
+  with their real schedule, and a heartbeat is sent around each run.
+- No runtime dependency; never fails or blocks a job; bounded queue; survives a fork.

silencewatch-0.1.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 [yyyy] [name of copyright owner]
+
+   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.

silencewatch-0.1.0/PKG-INFO

@@ -0,0 +1,212 @@
+Metadata-Version: 2.5
+Name: silencewatch
+Version: 0.1.0
+Summary: Declare and monitor the scheduled jobs of a Python application with SilenceWatch: Celery beat, APScheduler.
+Project-URL: Homepage, https://silencewatch.com/python/
+Project-URL: Documentation, https://silencewatch.com/docs/python/
+Project-URL: Source, https://github.com/liliang-dev/SilenceWatch/tree/main/clients/python
+Project-URL: Changelog, https://github.com/liliang-dev/SilenceWatch/blob/main/clients/python/CHANGELOG.md
+Author: The SilenceWatch authors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: apscheduler,celery,cron,dead-mans-switch,heartbeat,monitoring,silencewatch
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Monitoring
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: apscheduler
+Requires-Dist: apscheduler<4,>=3.9; extra == 'apscheduler'
+Provides-Extra: celery
+Requires-Dist: celery>=5.2; extra == 'celery'
+Description-Content-Type: text/markdown
+
+# SilenceWatch for Python
+
+Add the library and an API key. The scheduled jobs of your application show up in
+SilenceWatch with their real schedule, and send a heartbeat around each run.
+
+Licensed under **Apache-2.0** — deliberately, so it can be embedded in any
+application without licence consequences.
+
+| Scheduler | Install | What it reads |
+| --- | --- | --- |
+| **Celery beat** | `pip install "silencewatch[celery]"` | the `beat_schedule` (crontab, `timedelta`, seconds) |
+| **APScheduler 3** | `pip install "silencewatch[apscheduler]"` | the jobs of the scheduler (cron and interval triggers) |
+
+More are planned; see [Adding an integration](#adding-an-integration).
+
+## Set up
+
+Create an API key in your project's Settings page and give it to the process:
+
+```bash
+export SILENCEWATCH_API_KEY=sw_...
+# export SILENCEWATCH_URL=https://watch.example.com   # only when you host SilenceWatch yourself
+```
+
+### Celery
+
+```python
+from celery import Celery
+from celery.schedules import crontab
+from silencewatch.integrations.celery import instrument
+
+app = Celery("shop")
+app.conf.beat_schedule = {
+    "nightly-backup": {"task": "shop.tasks.backup", "schedule": crontab(hour=2, minute=0)},
+    "sync-prices": {"task": "shop.tasks.sync_prices", "schedule": 900.0},
+}
+instrument(app)
+```
+
+Workers declare the schedule when they start, and send a heartbeat from the worker
+that runs each scheduled task. Nothing else to write.
+
+### APScheduler
+
+```python
+from apscheduler.schedulers.background import BackgroundScheduler
+from silencewatch.integrations.apscheduler import instrument
+
+scheduler = BackgroundScheduler()
+scheduler.add_job(backup, "cron", hour=2, id="nightly-backup")
+scheduler.add_job(sync_prices, "interval", minutes=15, id="sync-prices")
+instrument(scheduler)
+scheduler.start()
+```
+
+**Give each job an `id`.** APScheduler makes up a random one otherwise, which changes
+on every start and cannot tie a job to its history. Without an id the job is
+identified by the function it runs, which is stable.
+
+## What it does
+
+At startup, in **one HTTP call**, every job found is declared to
+`POST /api/v1/checks/sync` and the returned ping keys are kept in memory. Around
+each run:
+
+```
+POST /p/<key>/start                     when the run begins
+POST /p/<key>/0?duration_ms=1234        when it returns
+POST /p/<key>/fail?duration_ms=1234     when it raises
+```
+
+Each job gets a **stable identity**, which is what ties it to its history on the
+server across restarts, redeployments and renames:
+
+| Integration | Key |
+| --- | --- |
+| Celery | `celery:shop.tasks.backup` (the task name) |
+| APScheduler | `apscheduler:nightly-backup` (the job id, else `apscheduler:app.jobs:backup`, the function) |
+
+Jobs that disappear from the code are **flagged orphaned on the server, never
+deleted**.
+
+## Configuration
+
+Every setting is a keyword argument (`instrument(app, api_key="…", environment="staging")`)
+and an environment variable. The keyword wins. Durations in the environment are a
+number of seconds.
+
+| Keyword | Environment variable | Default | |
+| --- | --- | --- | --- |
+| `api_key` | `SILENCEWATCH_API_KEY` | — | Without one nothing is sent |
+| `base_url` | `SILENCEWATCH_URL` | `https://app.silencewatch.com` | Your own instance when self-hosting |
+| `environment` | `SILENCEWATCH_ENVIRONMENT` | `production` | Part of a check's identity |
+| `enabled` | `SILENCEWATCH_ENABLED` | `true` | `false` removes everything, see below |
+| `default_grace` | `SILENCEWATCH_DEFAULT_GRACE` | `5 min` | For jobs that declare none |
+| `auto_register` | `SILENCEWATCH_AUTO_REGISTER` | `true` | `false` to manage checks by hand |
+| `report_start` | `SILENCEWATCH_REPORT_START` | `true` | `false` to send only the outcome |
+| `timeout` | `SILENCEWATCH_TIMEOUT` | `2` (s) | Per call, deliberately short |
+| `queue_capacity` | `SILENCEWATCH_QUEUE_CAPACITY` | `1000` | Bounded, oldest dropped when full |
+| `timezone` | `SILENCEWATCH_TIMEZONE` | `UTC` | For cron jobs whose own schedule carries none |
+| `prune` | `SILENCEWATCH_PRUNE` | `true` | See below |
+
+`prune` flags as orphaned every check of the project and environment that the
+declaration leaves out. Use **one environment per application**; if several services
+share one project and environment, set `prune=False`, or each would orphan the
+others' checks.
+
+## Rules it will not break
+
+These are the reason the library is safe to put in a production application:
+
+- **It never fails your job.** Every network or HTTP error is swallowed and logged at
+  `WARNING`. Your task runs exactly once, and its result and its exception are untouched.
+- **It never blocks your job.** Sending a heartbeat is a queue append handled by a
+  daemon thread. An unreachable SilenceWatch costs your job nothing.
+- **It is bounded.** The queue holds at most `queue_capacity` heartbeats; past that the
+  oldest are dropped, because the freshest state is the one worth reporting. Warnings
+  are limited to one a minute so an outage cannot flood your logs.
+- **It degrades silently.** No API key, no network, no server: the application starts
+  and runs exactly as it would without the library. A process that started while
+  SilenceWatch was unreachable declares itself at its first heartbeat, at most once a
+  minute.
+- **It survives a fork.** Celery's prefork pool and gunicorn fork after the library
+  started; each child starts its own queue and thread.
+- **`enabled=False` removes the mechanism entirely**: no discovery, no hooks, no threads.
+- **No dependency.** The standard library only. `celery` and `apscheduler` are extras you
+  already have.
+
+## Notes and limits
+
+- **Celery** — a task scheduled by several beat entries is declared from the one that
+  fires most often. A **manual** `.delay()` of a scheduled task also sends a heartbeat,
+  since a worker cannot tell it from a scheduled one; do not rely on a task being called
+  by hand for the check to stay green. Solar schedules and schedules kept in a database
+  (`django-celery-beat`) are not read. A crontab that restricts both the day of the month
+  and the day of the week fires when both match in Celery and when either does in cron;
+  the log says so.
+- **APScheduler** — version 3 only (4 has another API). A job's duration includes any time
+  it waited for an executor. One-off `date` triggers, combined `and`/`or` triggers and the
+  `week`, `year` and "third friday" cron fields cannot be expressed and are skipped, with a
+  warning. Jobs added or removed after the scheduler started are declared again two
+  seconds later.
+- **Sub-30-second jobs** are declared with a 30-second period, the shortest the server
+  accepts, and a warning names them.
+- **Cron expressions the server cannot evaluate** (Quartz's `W`) are skipped with a
+  warning rather than failing the whole declaration.
+
+## Adding an integration
+
+The package is organised so the next scheduler (Django, RQ, Dramatiq, a cron wrapper…)
+is one module:
+
+```
+src/silencewatch/
+  config.py          settings, from keywords and SILENCEWATCH_* variables
+  model.py           DiscoveredJob: what an integration reports
+  client.py          the HTTP calls (declaration, heartbeat), standard library only
+  heartbeat.py       the bounded queue and the thread, fork-safe
+  monitor.py         one per process: declares everything in one request, sends the runs
+  cron.py            the cron dialect the server reads, and helpers to write one
+  integrations/
+    base.py          the contract an integration follows
+    celery.py
+    apscheduler.py   ← a new scheduler goes here, next to these
+```
+
+An integration is a class with a `name`, a `discover()` that returns the jobs as
+`DiscoveredJob`s, and an `install(monitor)` that hooks the scheduler: it calls
+`monitor.declare(self, jobs)` when the scheduler is ready and `monitor.started`,
+`succeeded` or `failed` around each run. Add an `instrument(...)` function that creates
+it and calls `monitor.attach(...)`, tests next to the others, and the README row above.
+Nothing else changes.
+
+## Development
+
+```bash
+pip install -e ".[celery,apscheduler]" -r requirements.txt   # Python 3.10+ for the lint tools
+ruff check . && mypy && pytest
+```
+
+The tests start a small stand-in for SilenceWatch, so the real HTTP code runs.

silencewatch-0.1.0/README.md

@@ -0,0 +1,181 @@
+# SilenceWatch for Python
+
+Add the library and an API key. The scheduled jobs of your application show up in
+SilenceWatch with their real schedule, and send a heartbeat around each run.
+
+Licensed under **Apache-2.0** — deliberately, so it can be embedded in any
+application without licence consequences.
+
+| Scheduler | Install | What it reads |
+| --- | --- | --- |
+| **Celery beat** | `pip install "silencewatch[celery]"` | the `beat_schedule` (crontab, `timedelta`, seconds) |
+| **APScheduler 3** | `pip install "silencewatch[apscheduler]"` | the jobs of the scheduler (cron and interval triggers) |
+
+More are planned; see [Adding an integration](#adding-an-integration).
+
+## Set up
+
+Create an API key in your project's Settings page and give it to the process:
+
+```bash
+export SILENCEWATCH_API_KEY=sw_...
+# export SILENCEWATCH_URL=https://watch.example.com   # only when you host SilenceWatch yourself
+```
+
+### Celery
+
+```python
+from celery import Celery
+from celery.schedules import crontab
+from silencewatch.integrations.celery import instrument
+
+app = Celery("shop")
+app.conf.beat_schedule = {
+    "nightly-backup": {"task": "shop.tasks.backup", "schedule": crontab(hour=2, minute=0)},
+    "sync-prices": {"task": "shop.tasks.sync_prices", "schedule": 900.0},
+}
+instrument(app)
+```
+
+Workers declare the schedule when they start, and send a heartbeat from the worker
+that runs each scheduled task. Nothing else to write.
+
+### APScheduler
+
+```python
+from apscheduler.schedulers.background import BackgroundScheduler
+from silencewatch.integrations.apscheduler import instrument
+
+scheduler = BackgroundScheduler()
+scheduler.add_job(backup, "cron", hour=2, id="nightly-backup")
+scheduler.add_job(sync_prices, "interval", minutes=15, id="sync-prices")
+instrument(scheduler)
+scheduler.start()
+```
+
+**Give each job an `id`.** APScheduler makes up a random one otherwise, which changes
+on every start and cannot tie a job to its history. Without an id the job is
+identified by the function it runs, which is stable.
+
+## What it does
+
+At startup, in **one HTTP call**, every job found is declared to
+`POST /api/v1/checks/sync` and the returned ping keys are kept in memory. Around
+each run:
+
+```
+POST /p/<key>/start                     when the run begins
+POST /p/<key>/0?duration_ms=1234        when it returns
+POST /p/<key>/fail?duration_ms=1234     when it raises
+```
+
+Each job gets a **stable identity**, which is what ties it to its history on the
+server across restarts, redeployments and renames:
+
+| Integration | Key |
+| --- | --- |
+| Celery | `celery:shop.tasks.backup` (the task name) |
+| APScheduler | `apscheduler:nightly-backup` (the job id, else `apscheduler:app.jobs:backup`, the function) |
+
+Jobs that disappear from the code are **flagged orphaned on the server, never
+deleted**.
+
+## Configuration
+
+Every setting is a keyword argument (`instrument(app, api_key="…", environment="staging")`)
+and an environment variable. The keyword wins. Durations in the environment are a
+number of seconds.
+
+| Keyword | Environment variable | Default | |
+| --- | --- | --- | --- |
+| `api_key` | `SILENCEWATCH_API_KEY` | — | Without one nothing is sent |
+| `base_url` | `SILENCEWATCH_URL` | `https://app.silencewatch.com` | Your own instance when self-hosting |
+| `environment` | `SILENCEWATCH_ENVIRONMENT` | `production` | Part of a check's identity |
+| `enabled` | `SILENCEWATCH_ENABLED` | `true` | `false` removes everything, see below |
+| `default_grace` | `SILENCEWATCH_DEFAULT_GRACE` | `5 min` | For jobs that declare none |
+| `auto_register` | `SILENCEWATCH_AUTO_REGISTER` | `true` | `false` to manage checks by hand |
+| `report_start` | `SILENCEWATCH_REPORT_START` | `true` | `false` to send only the outcome |
+| `timeout` | `SILENCEWATCH_TIMEOUT` | `2` (s) | Per call, deliberately short |
+| `queue_capacity` | `SILENCEWATCH_QUEUE_CAPACITY` | `1000` | Bounded, oldest dropped when full |
+| `timezone` | `SILENCEWATCH_TIMEZONE` | `UTC` | For cron jobs whose own schedule carries none |
+| `prune` | `SILENCEWATCH_PRUNE` | `true` | See below |
+
+`prune` flags as orphaned every check of the project and environment that the
+declaration leaves out. Use **one environment per application**; if several services
+share one project and environment, set `prune=False`, or each would orphan the
+others' checks.
+
+## Rules it will not break
+
+These are the reason the library is safe to put in a production application:
+
+- **It never fails your job.** Every network or HTTP error is swallowed and logged at
+  `WARNING`. Your task runs exactly once, and its result and its exception are untouched.
+- **It never blocks your job.** Sending a heartbeat is a queue append handled by a
+  daemon thread. An unreachable SilenceWatch costs your job nothing.
+- **It is bounded.** The queue holds at most `queue_capacity` heartbeats; past that the
+  oldest are dropped, because the freshest state is the one worth reporting. Warnings
+  are limited to one a minute so an outage cannot flood your logs.
+- **It degrades silently.** No API key, no network, no server: the application starts
+  and runs exactly as it would without the library. A process that started while
+  SilenceWatch was unreachable declares itself at its first heartbeat, at most once a
+  minute.
+- **It survives a fork.** Celery's prefork pool and gunicorn fork after the library
+  started; each child starts its own queue and thread.
+- **`enabled=False` removes the mechanism entirely**: no discovery, no hooks, no threads.
+- **No dependency.** The standard library only. `celery` and `apscheduler` are extras you
+  already have.
+
+## Notes and limits
+
+- **Celery** — a task scheduled by several beat entries is declared from the one that
+  fires most often. A **manual** `.delay()` of a scheduled task also sends a heartbeat,
+  since a worker cannot tell it from a scheduled one; do not rely on a task being called
+  by hand for the check to stay green. Solar schedules and schedules kept in a database
+  (`django-celery-beat`) are not read. A crontab that restricts both the day of the month
+  and the day of the week fires when both match in Celery and when either does in cron;
+  the log says so.
+- **APScheduler** — version 3 only (4 has another API). A job's duration includes any time
+  it waited for an executor. One-off `date` triggers, combined `and`/`or` triggers and the
+  `week`, `year` and "third friday" cron fields cannot be expressed and are skipped, with a
+  warning. Jobs added or removed after the scheduler started are declared again two
+  seconds later.
+- **Sub-30-second jobs** are declared with a 30-second period, the shortest the server
+  accepts, and a warning names them.
+- **Cron expressions the server cannot evaluate** (Quartz's `W`) are skipped with a
+  warning rather than failing the whole declaration.
+
+## Adding an integration
+
+The package is organised so the next scheduler (Django, RQ, Dramatiq, a cron wrapper…)
+is one module:
+
+```
+src/silencewatch/
+  config.py          settings, from keywords and SILENCEWATCH_* variables
+  model.py           DiscoveredJob: what an integration reports
+  client.py          the HTTP calls (declaration, heartbeat), standard library only
+  heartbeat.py       the bounded queue and the thread, fork-safe
+  monitor.py         one per process: declares everything in one request, sends the runs
+  cron.py            the cron dialect the server reads, and helpers to write one
+  integrations/
+    base.py          the contract an integration follows
+    celery.py
+    apscheduler.py   ← a new scheduler goes here, next to these
+```
+
+An integration is a class with a `name`, a `discover()` that returns the jobs as
+`DiscoveredJob`s, and an `install(monitor)` that hooks the scheduler: it calls
+`monitor.declare(self, jobs)` when the scheduler is ready and `monitor.started`,
+`succeeded` or `failed` around each run. Add an `instrument(...)` function that creates
+it and calls `monitor.attach(...)`, tests next to the others, and the README row above.
+Nothing else changes.
+
+## Development
+
+```bash
+pip install -e ".[celery,apscheduler]" -r requirements.txt   # Python 3.10+ for the lint tools
+ruff check . && mypy && pytest
+```
+
+The tests start a small stand-in for SilenceWatch, so the real HTTP code runs.