Repository navigation
Home
Welcome to the fiscalclock wiki! This page says what fiscalclock is, where it stands today and where each topic is documented.
Last reviewed: 1 Nov 2026
fiscalclock is an open-source fiscal calendar engine. You describe your organisation's fiscal calendar as a JSON definition, and fiscalclock tells you which fiscal year, quarter, period and week any date falls in, the bounds of every period, and the labels your organisation uses for them (README).
- All logic lives in one Rust core, the crate
fiscalclockincrates/core. - Thin Python and npm packages call the core's JSON API and return its JSON unchanged, so the same definition gives byte-identical results in Rust, Python and JavaScript. See Architecture.
- There are no built-in calendars. Well-known calendars such as NRF 4-5-4 appear only as example definitions in the documentation and the test vectors (ADR-0004).
- Results are used for financial reporting dates, so every behaviour is backed by a cited source or an independent check. See Testing-Strategy and Evidence.
Holidays, business days, working hours, pay periods and sprints are out of scope (ADR-0015).
- Built and tested: version 0.1.0 of the Rust crate, the Python package and the npm package. CI run 41222104138 passed on Linux, macOS and Windows, and the release dry run 41222111858 built every package and passed its smoke tests.
-
Released: 0.1.0 is on crates.io, PyPI and npm since 31 Oct 2026 (v0.1.0). Releases are published only by
release.ymlfrom a version tag, with trusted publishing and the maintainer's approval. - Planned: exceptions and table years (0.2), comparable periods and equivalent day (0.3), the CLI and MCP server (0.4). See Roadmap.
| Page | What it covers |
|---|---|
| Home | This page: what fiscalclock is, its status, and the page map. |
| Glossary | The terms every page uses, and the words to avoid. |
| Roadmap | Six phases and the gate of checks that closes each one. |
| Page | What it covers |
|---|---|
| Analysis | How fiscal calendars work in practice and what existing tools cover. |
| Evidence | The source or reproducible check behind each factual claim. |
| PDR | Product design requirements: problem, goals, requirements and acceptance criteria. |
| Definition-Format | The five blocks of a definition, field by field, with validation codes and worked examples. |
| Semantics | Half-open intervals, labels, date inputs, the supported range and year numbering; planned comparison and proration rules. |
| Architecture | One Rust core and thin bindings, the JSON API boundary, the cross-binding check and the release pipeline. |
| Agents-and-MCP | The planned agent contract: describe, infer, explain, the MCP tools and the registry. |
| Testing-Strategy | Conformance vectors, the differential test, property tests and what is still planned. |
| Page | What it covers |
|---|---|
| ADR-Index | Every architecture decision record, with its status. |
| Page | What it covers |
|---|---|
| Risks | Known risks with likelihood, impact, mitigation and the phase that owns each one. |
Report a wrong result, propose a calendar shape or suggest a documentation fix through the issue forms. Read CONTRIBUTING.md first. Real-world calendars with a cited source are especially useful as conformance vectors.
fiscalclock is licensed under MIT OR Apache-2.0 (MIT, Apache-2.0). Last reviewed: 31 Oct 2026. Found an error on this page? Report it with the documentation form.