schedium 0.0.0__tar.gz

schedium-0.0.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.

schedium-0.0.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: schedium
+Version: 0.0.0
+Summary: Automatically trigger jobs at specific times
+Maintainer-email: Marc Bresson <m.bresson@mailo.eu>
+Project-URL: Repository, https://github.com/MarcBresson
+Project-URL: Issues, https://github.com/MarcBresson
+Project-URL: Changelog, https://github.com/MarcBresson
+Keywords: scheduling
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+<p align="center">
+  <img src="docs/logo.svg" alt="schedium logo" width="180" />
+</p>
+
+<h1 align="center">schedium</h1>
+
+<p align="center">
+  <em>A lightweight, composable, in-process job scheduler for Python.</em>
+</p>
+
+<p align="center">
+  <a href="https://github.com/MarcBresson/schedium/actions/workflows/tests.yml"><img src="https://github.com/MarcBresson/schedium/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
+  <a href="https://github.com/MarcBresson/schedium/actions/workflows/docs.yml"><img src="https://github.com/MarcBresson/schedium/actions/workflows/docs.yml/badge.svg" alt="Docs"></a>
+  <a href="https://pypi.org/project/schedium/"><img src="https://img.shields.io/pypi/v/schedium?color=blue" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/schedium/"><img src="https://img.shields.io/pypi/pyversions/schedium" alt="Python versions"></a>
+  <a href="https://github.com/MarcBresson/schedium/blob/main/LICENSE"><img src="https://img.shields.io/github/license/MarcBresson/schedium" alt="License"></a>
+  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
+  <a href="https://numpydoc.readthedocs.io/en/latest/format.html"><img src="https://img.shields.io/badge/docstyle-numpydoc-blue" alt="numpydoc"></a>
+  <a href="http://mypy-lang.org/"><img src="https://img.shields.io/badge/type--checked-mypy-blue" alt="mypy"></a>
+</p>
+
+---
+
+## Why schedium?
+
+Most Python schedulers either require a background thread / daemon or force you into a rigid cron syntax. **schedium** takes a different approach:
+
+- **No threads, no processes** — jobs run inline when you call `run_pending()`.
+- **Composable triggers** — build complex schedules by combining simple primitives with `&` (AND) and `|` (OR).
+- **Automatic deduplication** — calling `run_pending()` multiple times within the same time bucket is safe; jobs run at most once per bucket.
+- **Zero dependencies** — pure Python, nothing outside the standard library.
+- **Fully typed** — first-class type annotations and mypy-checked.
+- support all currently maintained python versions: 3.10, 3.11, 3.12, 3.13, and 3.14
+
+[link to the documentation](https://schedium.readthedocs.io)
+
+## Installation
+
+```bash
+pip install schedium
+```
+
+## Quick start
+
+```python
+import time
+from schedium import Every, Job, Scheduler, Weekly
+
+sched = Scheduler()
+
+def hello():
+    print("hello!")
+
+# Every 5 minutes
+sched.append(Job(hello, Every(unit="minute", interval=5), name="5-min"))
+
+# Every Monday at 09:30
+sched.append(Job(hello, Weekly("monday", at="09:30"), name="weekly"))
+
+while True:
+    sched.run_pending()
+    time.sleep(1)
+```
+
+## Composing triggers
+
+Triggers are the building blocks of schedules. Combine them freely:
+
+```python
+from schedium import Every, On, Between
+
+# Every minute, but only on weekdays between 9 AM and 5 PM
+trigger = (
+    Every(unit="minute", interval=1)
+    & On(unit="weekdays")
+    & Between(unit="hour_of_day", start=9, end=17)
+)
+```
+
+```python
+from schedium import Every, On
+
+# Every hour, at minute 12 OR minute 55
+trigger = (
+    Every(unit="hour", interval=1)
+    & (On(unit="minute_of_hour", value=12) | On(unit="minute_of_hour", value=55))
+)
+```
+
+### Available triggers
+
+| Trigger | Role | Example |
+|---|---|---|
+| `Every(unit, interval)` | Epoch-aligned cadence | `Every(unit="minute", interval=5)` |
+| `Tick(granularity)` | Always matches; sets the dedup bucket | `Tick("day")` |
+| `On(unit, value)` | Equality constraint | `On(unit="hour_of_day", value=8)` |
+| `Between(unit, start, end)` | Range constraint (inclusive) | `Between(unit="hour_of_day", start=9, end=17)` |
+| `AtDateTime(run_date)` | One-shot at a specific datetime | `AtDateTime(datetime(2026, 3, 1, 12, 0))` |
+| `BetweenDateTime(start, end)` | Datetime window constraint | `BetweenDateTime(start_date=..., end_date=...)` |
+| `Weekly(day, at=...)` | Convenience: weekly on a weekday | `Weekly("mon", at="09:30")` |
+| `trigger_a & trigger_b` | AND combinator | All conditions must match |
+| `trigger_a \| trigger_b` | OR combinator | Either condition can match |
+
+## Deduplication
+
+schedium automatically deduplicates job runs. Calling `run_pending()` repeatedly within the same time bucket will only execute the job once:
+
+```python
+from datetime import datetime
+from schedium import DidNotRun, Every, Job, Scheduler
+
+sched = Scheduler()
+sched.append(Job(lambda: print("tick"), Every(unit="minute", interval=1)))
+
+# First call at 10:05 → runs the job
+sched.run_pending(now=datetime(2026, 2, 4, 10, 5, 0))
+
+# Second call at 10:05 → already ran for this bucket
+result = sched.run_pending(now=datetime(2026, 2, 4, 10, 5, 0))
+assert result[0] is DidNotRun
+
+# Next minute → runs again
+sched.run_pending(now=datetime(2026, 2, 4, 10, 6, 0))
+```
+
+## Inspecting next run times
+
+```python
+from datetime import datetime
+from schedium import Every, Job, Scheduler
+
+sched = Scheduler()
+sched.append(Job(lambda: None, Every(unit="minute", interval=5)))
+
+next_run = sched.time_of_next_run(after=datetime(2026, 2, 4, 10, 3, 0))
+print(next_run)  # datetime(2026, 2, 4, 10, 5, 0)
+```
+
+## Timezone handling
+
+For predictable behavior, use UTC-aware datetimes:
+
+```python
+import time
+from datetime import datetime, timezone
+from schedium import Every, Job, Scheduler
+
+sched = Scheduler()
+sched.append(Job(lambda: print("tick"), Every(unit="minute", interval=1)))
+
+while True:
+    sched.run_pending(now=datetime.now(timezone.utc))
+    time.sleep(1)
+```
+
+Local timezones work too (via `zoneinfo`), but be aware of DST transitions — see the [docs](https://schedium.readthedocs.io) for details.
+
+## Documentation
+
+Full documentation is built with Sphinx and hosted alongside the project:
+
+- **Guides**: Scheduler usage, job creation, trigger composition
+- **Concepts**: Granularity, trigger tokens & deduplication, window time
+- **API reference**: Every class and function documented with numpydoc
+
+Build locally:
+
+```bash
+pip install -e . --group docs
+sphinx-build -b html docs docs/_build/html
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/MarcBresson/schedium.git
+cd schedium
+python -m venv .venv && source .venv/bin/activate
+pip install -e . --group dev --group test --group docs
+pre-commit install
+```
+
+### Run tests
+
+```bash
+pytest
+```
+
+### Linting & formatting
+
+The project uses [Ruff](https://github.com/astral-sh/ruff) for linting and formatting, [mypy](http://mypy-lang.org/) for type checking, and [numpydoc](https://numpydoc.readthedocs.io/) for docstring validation — all enforced via [pre-commit](https://pre-commit.com/):
+
+```bash
+pre-commit run --all-files
+```
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-feature`)
+3. Ensure all tests pass (`pytest`) and pre-commit hooks are clean
+4. Open a pull request
+
+## License
+
+schedium is licensed under the [Apache License 2.0](LICENSE).

schedium-0.0.0/README.md

@@ -0,0 +1,210 @@
+<p align="center">
+  <img src="docs/logo.svg" alt="schedium logo" width="180" />
+</p>
+
+<h1 align="center">schedium</h1>
+
+<p align="center">
+  <em>A lightweight, composable, in-process job scheduler for Python.</em>
+</p>
+
+<p align="center">
+  <a href="https://github.com/MarcBresson/schedium/actions/workflows/tests.yml"><img src="https://github.com/MarcBresson/schedium/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
+  <a href="https://github.com/MarcBresson/schedium/actions/workflows/docs.yml"><img src="https://github.com/MarcBresson/schedium/actions/workflows/docs.yml/badge.svg" alt="Docs"></a>
+  <a href="https://pypi.org/project/schedium/"><img src="https://img.shields.io/pypi/v/schedium?color=blue" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/schedium/"><img src="https://img.shields.io/pypi/pyversions/schedium" alt="Python versions"></a>
+  <a href="https://github.com/MarcBresson/schedium/blob/main/LICENSE"><img src="https://img.shields.io/github/license/MarcBresson/schedium" alt="License"></a>
+  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
+  <a href="https://numpydoc.readthedocs.io/en/latest/format.html"><img src="https://img.shields.io/badge/docstyle-numpydoc-blue" alt="numpydoc"></a>
+  <a href="http://mypy-lang.org/"><img src="https://img.shields.io/badge/type--checked-mypy-blue" alt="mypy"></a>
+</p>
+
+---
+
+## Why schedium?
+
+Most Python schedulers either require a background thread / daemon or force you into a rigid cron syntax. **schedium** takes a different approach:
+
+- **No threads, no processes** — jobs run inline when you call `run_pending()`.
+- **Composable triggers** — build complex schedules by combining simple primitives with `&` (AND) and `|` (OR).
+- **Automatic deduplication** — calling `run_pending()` multiple times within the same time bucket is safe; jobs run at most once per bucket.
+- **Zero dependencies** — pure Python, nothing outside the standard library.
+- **Fully typed** — first-class type annotations and mypy-checked.
+- support all currently maintained python versions: 3.10, 3.11, 3.12, 3.13, and 3.14
+
+[link to the documentation](https://schedium.readthedocs.io)
+
+## Installation
+
+```bash
+pip install schedium
+```
+
+## Quick start
+
+```python
+import time
+from schedium import Every, Job, Scheduler, Weekly
+
+sched = Scheduler()
+
+def hello():
+    print("hello!")
+
+# Every 5 minutes
+sched.append(Job(hello, Every(unit="minute", interval=5), name="5-min"))
+
+# Every Monday at 09:30
+sched.append(Job(hello, Weekly("monday", at="09:30"), name="weekly"))
+
+while True:
+    sched.run_pending()
+    time.sleep(1)
+```
+
+## Composing triggers
+
+Triggers are the building blocks of schedules. Combine them freely:
+
+```python
+from schedium import Every, On, Between
+
+# Every minute, but only on weekdays between 9 AM and 5 PM
+trigger = (
+    Every(unit="minute", interval=1)
+    & On(unit="weekdays")
+    & Between(unit="hour_of_day", start=9, end=17)
+)
+```
+
+```python
+from schedium import Every, On
+
+# Every hour, at minute 12 OR minute 55
+trigger = (
+    Every(unit="hour", interval=1)
+    & (On(unit="minute_of_hour", value=12) | On(unit="minute_of_hour", value=55))
+)
+```
+
+### Available triggers
+
+| Trigger | Role | Example |
+|---|---|---|
+| `Every(unit, interval)` | Epoch-aligned cadence | `Every(unit="minute", interval=5)` |
+| `Tick(granularity)` | Always matches; sets the dedup bucket | `Tick("day")` |
+| `On(unit, value)` | Equality constraint | `On(unit="hour_of_day", value=8)` |
+| `Between(unit, start, end)` | Range constraint (inclusive) | `Between(unit="hour_of_day", start=9, end=17)` |
+| `AtDateTime(run_date)` | One-shot at a specific datetime | `AtDateTime(datetime(2026, 3, 1, 12, 0))` |
+| `BetweenDateTime(start, end)` | Datetime window constraint | `BetweenDateTime(start_date=..., end_date=...)` |
+| `Weekly(day, at=...)` | Convenience: weekly on a weekday | `Weekly("mon", at="09:30")` |
+| `trigger_a & trigger_b` | AND combinator | All conditions must match |
+| `trigger_a \| trigger_b` | OR combinator | Either condition can match |
+
+## Deduplication
+
+schedium automatically deduplicates job runs. Calling `run_pending()` repeatedly within the same time bucket will only execute the job once:
+
+```python
+from datetime import datetime
+from schedium import DidNotRun, Every, Job, Scheduler
+
+sched = Scheduler()
+sched.append(Job(lambda: print("tick"), Every(unit="minute", interval=1)))
+
+# First call at 10:05 → runs the job
+sched.run_pending(now=datetime(2026, 2, 4, 10, 5, 0))
+
+# Second call at 10:05 → already ran for this bucket
+result = sched.run_pending(now=datetime(2026, 2, 4, 10, 5, 0))
+assert result[0] is DidNotRun
+
+# Next minute → runs again
+sched.run_pending(now=datetime(2026, 2, 4, 10, 6, 0))
+```
+
+## Inspecting next run times
+
+```python
+from datetime import datetime
+from schedium import Every, Job, Scheduler
+
+sched = Scheduler()
+sched.append(Job(lambda: None, Every(unit="minute", interval=5)))
+
+next_run = sched.time_of_next_run(after=datetime(2026, 2, 4, 10, 3, 0))
+print(next_run)  # datetime(2026, 2, 4, 10, 5, 0)
+```
+
+## Timezone handling
+
+For predictable behavior, use UTC-aware datetimes:
+
+```python
+import time
+from datetime import datetime, timezone
+from schedium import Every, Job, Scheduler
+
+sched = Scheduler()
+sched.append(Job(lambda: print("tick"), Every(unit="minute", interval=1)))
+
+while True:
+    sched.run_pending(now=datetime.now(timezone.utc))
+    time.sleep(1)
+```
+
+Local timezones work too (via `zoneinfo`), but be aware of DST transitions — see the [docs](https://schedium.readthedocs.io) for details.
+
+## Documentation
+
+Full documentation is built with Sphinx and hosted alongside the project:
+
+- **Guides**: Scheduler usage, job creation, trigger composition
+- **Concepts**: Granularity, trigger tokens & deduplication, window time
+- **API reference**: Every class and function documented with numpydoc
+
+Build locally:
+
+```bash
+pip install -e . --group docs
+sphinx-build -b html docs docs/_build/html
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/MarcBresson/schedium.git
+cd schedium
+python -m venv .venv && source .venv/bin/activate
+pip install -e . --group dev --group test --group docs
+pre-commit install
+```
+
+### Run tests
+
+```bash
+pytest
+```
+
+### Linting & formatting
+
+The project uses [Ruff](https://github.com/astral-sh/ruff) for linting and formatting, [mypy](http://mypy-lang.org/) for type checking, and [numpydoc](https://numpydoc.readthedocs.io/) for docstring validation — all enforced via [pre-commit](https://pre-commit.com/):
+
+```bash
+pre-commit run --all-files
+```
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-feature`)
+3. Ensure all tests pass (`pytest`) and pre-commit hooks are clean
+4. Open a pull request
+
+## License
+
+schedium is licensed under the [Apache License 2.0](LICENSE).