euclidean-rhythm 0.2.0__tar.gz

euclidean_rhythm-0.2.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Report incorrect output or an unexpected error
+labels: bug
+---
+
+**Function called**
+<!-- e.g. euclidean(pulses=3, steps=8) -->
+
+**Input**
+<!-- The rhythm vector or parameters -->
+
+**Expected output**
+<!-- What you expected -->
+
+**Actual output**
+<!-- What you got -->
+
+**Python version**
+<!-- e.g. 3.11.4 -->
+
+**euclidean-rhythm version**
+<!-- e.g. 0.1.0 -->

euclidean_rhythm-0.2.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest a new rhythm measure or generation algorithm
+labels: enhancement
+---
+
+**What would you like?**
+<!-- Describe the feature -->
+
+**Reference**
+<!-- If it's a published measure or algorithm, please cite the paper -->
+
+**Example**
+<!-- Show a concrete input/output example -->

euclidean_rhythm-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - run: pip install -e ".[dev]"
+      - run: ruff check .
+      - run: mypy src
+      - run: pytest -q

euclidean_rhythm-0.2.0/.gitignore

@@ -0,0 +1,18 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+dist/
+build/
+*.egg
+.venv/
+venv/
+env/
+.env
+*.so
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.hypothesis/
+uv.lock
+*.dist-info/

euclidean_rhythm-0.2.0/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Planned
+- PyPI release (pending new-project quota reset)
+
+## [0.2.0] - 2026-06-17
+
+### Added
+- `offbeatness(rhythm)`: Toussaint's offbeatness -- count of onsets landing on off-beat
+  positions. Off-beat positions are those p with gcd(p, n) == 1 (equivalently, positions
+  not covered by any regular subdivision). PyPI publish queued behind new-project quota.
+- `inter_onset_intervals(rhythm)`: gaps in pulses between consecutive onsets, wrapping
+  around the cycle. Always sums to n. Raises ValueError for zero onsets.
+- `ioi_histogram(rhythm)`: histogram (interval length -> count) of inter-onset intervals.
+- `onset_positions(rhythm)`: indices of onsets in a 0/1 rhythm vector.
+- `pattern_from_onsets(*, positions, steps)`: inverse converter -- build a 0/1 pattern
+  from onset indices. Completes a round-trip with onset_positions.
+
+## [0.1.0] - 2026-06-17
+
+### Added
+- `euclidean(*, pulses, steps)`: Bjorklund's algorithm for Euclidean rhythm generation.
+- `rotate(rhythm, *, steps)`: Left rotation by steps (mod len).
+- `necklace(rhythm)`: Lexicographically minimal rotation (canonical necklace form).
+- `evenness(rhythm)`: Toussaint's geometric evenness on the unit circle, normalized to [0, 1].
+- `syncopation(rhythm)`: Keith's (1991) syncopation measure based on metric weight differences.
+- `rhythmic_oddity(rhythm)`: Pressing's (1983) rhythmic oddity property.
+- `euclidean-rhythm` CLI: print a generated rhythm as `x`/`.` characters.

euclidean_rhythm-0.2.0/CLAUDE.md

@@ -0,0 +1,47 @@
+# euclidean-rhythm
+
+Pure-Python Euclidean rhythm generation and analysis. Zero runtime dependencies.
+
+## Commands
+
+- Create env and install: `uv venv && uv pip install -e ".[dev]"`
+- Test: `uv run pytest -q`
+- Lint: `uv run ruff check .` (format with `uv run ruff format .`)
+- Types: `uv run mypy src`
+- Build: `uv build` (then `uv run --with twine twine check dist/*` before publishing)
+
+## Architecture
+
+`src/euclidean_rhythm/`:
+- `generation.py`: Bjorklund's algorithm for euclidean()
+- `operations.py`: rotate() and necklace()
+- `analysis.py`: evenness(), syncopation(), rhythmic_oddity()
+- `cli.py`: euclidean-rhythm CLI
+- `__init__.py`: public surface
+
+See `docs/architecture.md` for precise definitions and references.
+
+## Conventions
+
+- Rhythms are `list[int]` of 0/1 onset values.
+- All parameters are keyword-only with no default values.
+- Pure functions, strict typing, zero runtime dependencies (only `math`).
+- Validate inputs and raise clear ValueError messages.
+
+## Testing rules
+
+- Golden values for named rhythms (son clave, bossa nova).
+- Hypothesis property tests for pulse count, length, rotation invariance.
+- Exact values for evenness (1.0 for maximally even) and syncopation.
+- Bug fixes start with a failing test.
+
+## Release
+
+- Semantic versioning; update CHANGELOG.md and __version__.
+- Gates: `uv run pytest && uv run ruff check . && uv run mypy src && uv build && uv run --with twine twine check dist/*`.
+- Do NOT publish to PyPI (pending quota reset). Tag vX.Y.Z and GitHub release.
+
+## Style
+
+- No em dash characters in docs, comments, or commit messages.
+- Comments explain non-obvious reasoning only.

euclidean_rhythm-0.2.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,37 @@
+# Code of Conduct
+
+## Our pledge
+
+We as members, contributors, and maintainers pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Showing empathy and kindness toward other people.
+- Being respectful of differing opinions, viewpoints, and experiences.
+- Giving and gracefully accepting constructive feedback.
+- Focusing on what is best for the community.
+
+Examples of unacceptable behavior:
+
+- Harassment, insulting or derogatory comments, and personal or political attacks.
+- Public or private harassment.
+- Publishing others' private information without explicit permission.
+- Other conduct which could reasonably be considered inappropriate.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the maintainer at amaar2cool@gmail.com. All complaints will be
+reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1.

euclidean_rhythm-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing to euclidean-rhythm
+
+Thanks for your interest. This project values correctness, precise definitions, and zero
+runtime dependencies.
+
+## Development
+
+```sh
+uv venv
+uv pip install -e ".[dev]"
+uv run pytest -q
+uv run ruff check .
+uv run mypy src
+```
+
+A standard virtual environment with `pip install -e ".[dev]"` works the same way.
+
+## Guidelines
+
+- No runtime dependencies. Standard library `math` is enough.
+- All functions are pure, with keyword-only parameters and no default values.
+- Every function needs exact-value tests and, where applicable, property tests (Hypothesis).
+- A bug fix starts with a failing test.
+- Run `uv run ruff format .` before committing.
+- Commit messages follow `type(scope): description`.
+- No em dash characters in code, comments, or commit messages.
+
+## Reporting issues
+
+Open an issue with the rhythm vector, the function called, and what you expected versus
+what you observed.

euclidean_rhythm-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Amaar Chughtai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

euclidean_rhythm-0.2.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: euclidean-rhythm
+Version: 0.2.0
+Summary: Euclidean rhythms (Bjorklund) with Toussaint evenness, Keith syncopation, and Pressing rhythmic oddity, in pure Python.
+Project-URL: Homepage, https://github.com/amaar-mc/euclidean-rhythm
+Project-URL: Repository, https://github.com/amaar-mc/euclidean-rhythm
+Project-URL: Issues, https://github.com/amaar-mc/euclidean-rhythm/issues
+Project-URL: Changelog, https://github.com/amaar-mc/euclidean-rhythm/blob/main/CHANGELOG.md
+Author: Amaar Chughtai
+License: MIT License
+        
+        Copyright (c) 2026 Amaar Chughtai
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: bjorklund,euclidean-rhythm,generative-music,music,music-theory,python,rhythm,toussaint
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+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: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: hypothesis>=6; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# euclidean-rhythm
+
+<p align="center">
+  <img src="assets/logo.png" alt="euclidean-rhythm logo" width="160">
+</p>
+
+Generate Euclidean rhythms and analyze them with standard geometric measures, in pure Python with zero dependencies.
+
+## What are Euclidean rhythms?
+
+Euclidean rhythms distribute `k` onsets as evenly as possible over `n` time steps using
+Bjorklund's algorithm - the same Euclidean GCD logic that underlies many traditional
+musical patterns worldwide.
+
+**The son clave** (3 onsets, 8 steps): `x . . x . . x .`
+**The bossa nova clave** (5 onsets, 8 steps): `x . x x . x x .`
+
+## Install
+
+```sh
+pip install euclidean-rhythm
+```
+
+> PyPI release pending. Install from source:
+> ```sh
+> git clone https://github.com/amaar-mc/euclidean-rhythm
+> cd euclidean-rhythm
+> pip install -e .
+> ```
+
+## Quick start
+
+```python
+from euclidean_rhythm import (
+    euclidean,
+    evenness,
+    inter_onset_intervals,
+    ioi_histogram,
+    necklace,
+    offbeatness,
+    onset_positions,
+    pattern_from_onsets,
+    rhythmic_oddity,
+    rotate,
+    syncopation,
+)
+
+# Generate rhythms
+son = euclidean(pulses=3, steps=8)
+# [1, 0, 0, 1, 0, 0, 1, 0]
+
+bossa = euclidean(pulses=5, steps=8)
+# [1, 0, 1, 1, 0, 1, 1, 0]
+
+# Rotate
+rotate(son, steps=2)
+# [0, 1, 0, 0, 1, 0, 1, 0]
+
+# Canonical necklace form (rotation-invariant)
+necklace(son) == necklace(rotate(son, steps=3))
+# True
+
+# Evenness (1.0 = maximally even)
+evenness(euclidean(pulses=4, steps=8))
+# 1.0
+
+# Keith syncopation (0 = no syncopation)
+syncopation(euclidean(pulses=4, steps=8))
+# 0
+
+# Pressing rhythmic oddity
+rhythmic_oddity(son)
+# True
+
+# Off-beat onset count (Toussaint offbeatness)
+offbeatness(son)
+# 1  -- onset at position 3 is off-beat in n=8; 0 and 6 are on-beat
+
+# Inter-onset intervals (gaps in pulses, wrapping)
+inter_onset_intervals(son)
+# [3, 3, 2]  -- sums to 8
+
+# Histogram of inter-onset intervals
+ioi_histogram(son)
+# {3: 2, 2: 1}
+
+# Convert between 0/1 pattern and onset-position list
+onset_positions(son)
+# [0, 3, 6]
+pattern_from_onsets(positions=[0, 3, 6], steps=8)
+# [1, 0, 0, 1, 0, 0, 1, 0]
+```
+
+## CLI
+
+```sh
+euclidean-rhythm 3 8
+# x..x..x.
+
+euclidean-rhythm 5 8
+# x.xx.xx.
+```
+
+## API
+
+All parameters are keyword-only.
+
+| Function | Description |
+|---|---|
+| `euclidean(*, pulses, steps)` | Generate Euclidean rhythm (Bjorklund's algorithm) |
+| `rotate(rhythm, *, steps)` | Rotate left by steps (mod len) |
+| `necklace(rhythm)` | Lexicographically minimal rotation (canonical form) |
+| `evenness(rhythm)` | Toussaint geometric evenness in (0, 1] |
+| `syncopation(rhythm)` | Keith (1991) syncopation count |
+| `rhythmic_oddity(rhythm)` | Pressing (1983) rhythmic oddity property |
+| `offbeatness(rhythm)` | Count of onsets on off-beat positions (gcd-coprime to n) |
+| `inter_onset_intervals(rhythm)` | Gaps in pulses between consecutive onsets, wrapping |
+| `ioi_histogram(rhythm)` | Histogram of inter-onset interval lengths |
+| `onset_positions(rhythm)` | Indices of onsets in a 0/1 pattern |
+| `pattern_from_onsets(*, positions, steps)` | Build 0/1 pattern from onset indices |
+
+## Measures defined
+
+**Evenness** (Toussaint 2005): Place onsets on a unit circle; sum all pairwise chord
+lengths; normalize by the maximum (equally spaced onsets). Score 1.0 means maximally even.
+
+**Syncopation** (Keith 1991): Metric weight of position `i` is `n` for the downbeat
+(`i=0`) and the largest power of 2 dividing `i` for `i>0`. A syncopation occurs when
+an onset at a weak beat is followed by a rest at a stronger beat; the score accumulates
+the weight difference.
+
+**Rhythmic oddity** (Pressing 1983): True if no two onsets are diametrically opposite
+on the rhythm circle (no pair partitions the cycle into two equal halves).
+
+**Offbeatness** (Toussaint): For a cycle of n pulses, position p is off-beat iff
+gcd(p, n) == 1 -- equivalently, p is not covered by any regular subdivision of the
+cycle (union of {k*n/d} for proper divisors d of n). Offbeatness is the count of onsets
+at such positions. Both characterizations produce identical off-beat sets, verified for
+n in 2..64.
+
+**Inter-onset intervals**: The sequence of gaps (in pulses) between consecutive onsets
+around the cycle, wrapping from the last onset back to the first. Always sums to n.
+
+## References
+
+- Bjorklund, E. (2003). The theory of rep-rate pattern generation in the SNS timing system.
+- Toussaint, G. (2005). The Euclidean algorithm generates traditional musical rhythms. BRIDGES.
+- Keith, M. (1991). From Polychords to Polya: Adventures in Musical Combinatorics.
+- Pressing, J. (1983). Cognitive isomorphisms between pitch and rhythm in world musics. Studies in Music.
+
+## License
+
+MIT. Copyright (c) 2026 Amaar Chughtai.

euclidean_rhythm-0.2.0/README.md

@@ -0,0 +1,153 @@
+# euclidean-rhythm
+
+<p align="center">
+  <img src="assets/logo.png" alt="euclidean-rhythm logo" width="160">
+</p>
+
+Generate Euclidean rhythms and analyze them with standard geometric measures, in pure Python with zero dependencies.
+
+## What are Euclidean rhythms?
+
+Euclidean rhythms distribute `k` onsets as evenly as possible over `n` time steps using
+Bjorklund's algorithm - the same Euclidean GCD logic that underlies many traditional
+musical patterns worldwide.
+
+**The son clave** (3 onsets, 8 steps): `x . . x . . x .`
+**The bossa nova clave** (5 onsets, 8 steps): `x . x x . x x .`
+
+## Install
+
+```sh
+pip install euclidean-rhythm
+```
+
+> PyPI release pending. Install from source:
+> ```sh
+> git clone https://github.com/amaar-mc/euclidean-rhythm
+> cd euclidean-rhythm
+> pip install -e .
+> ```
+
+## Quick start
+
+```python
+from euclidean_rhythm import (
+    euclidean,
+    evenness,
+    inter_onset_intervals,
+    ioi_histogram,
+    necklace,
+    offbeatness,
+    onset_positions,
+    pattern_from_onsets,
+    rhythmic_oddity,
+    rotate,
+    syncopation,
+)
+
+# Generate rhythms
+son = euclidean(pulses=3, steps=8)
+# [1, 0, 0, 1, 0, 0, 1, 0]
+
+bossa = euclidean(pulses=5, steps=8)
+# [1, 0, 1, 1, 0, 1, 1, 0]
+
+# Rotate
+rotate(son, steps=2)
+# [0, 1, 0, 0, 1, 0, 1, 0]
+
+# Canonical necklace form (rotation-invariant)
+necklace(son) == necklace(rotate(son, steps=3))
+# True
+
+# Evenness (1.0 = maximally even)
+evenness(euclidean(pulses=4, steps=8))
+# 1.0
+
+# Keith syncopation (0 = no syncopation)
+syncopation(euclidean(pulses=4, steps=8))
+# 0
+
+# Pressing rhythmic oddity
+rhythmic_oddity(son)
+# True
+
+# Off-beat onset count (Toussaint offbeatness)
+offbeatness(son)
+# 1  -- onset at position 3 is off-beat in n=8; 0 and 6 are on-beat
+
+# Inter-onset intervals (gaps in pulses, wrapping)
+inter_onset_intervals(son)
+# [3, 3, 2]  -- sums to 8
+
+# Histogram of inter-onset intervals
+ioi_histogram(son)
+# {3: 2, 2: 1}
+
+# Convert between 0/1 pattern and onset-position list
+onset_positions(son)
+# [0, 3, 6]
+pattern_from_onsets(positions=[0, 3, 6], steps=8)
+# [1, 0, 0, 1, 0, 0, 1, 0]
+```
+
+## CLI
+
+```sh
+euclidean-rhythm 3 8
+# x..x..x.
+
+euclidean-rhythm 5 8
+# x.xx.xx.
+```
+
+## API
+
+All parameters are keyword-only.
+
+| Function | Description |
+|---|---|
+| `euclidean(*, pulses, steps)` | Generate Euclidean rhythm (Bjorklund's algorithm) |
+| `rotate(rhythm, *, steps)` | Rotate left by steps (mod len) |
+| `necklace(rhythm)` | Lexicographically minimal rotation (canonical form) |
+| `evenness(rhythm)` | Toussaint geometric evenness in (0, 1] |
+| `syncopation(rhythm)` | Keith (1991) syncopation count |
+| `rhythmic_oddity(rhythm)` | Pressing (1983) rhythmic oddity property |
+| `offbeatness(rhythm)` | Count of onsets on off-beat positions (gcd-coprime to n) |
+| `inter_onset_intervals(rhythm)` | Gaps in pulses between consecutive onsets, wrapping |
+| `ioi_histogram(rhythm)` | Histogram of inter-onset interval lengths |
+| `onset_positions(rhythm)` | Indices of onsets in a 0/1 pattern |
+| `pattern_from_onsets(*, positions, steps)` | Build 0/1 pattern from onset indices |
+
+## Measures defined
+
+**Evenness** (Toussaint 2005): Place onsets on a unit circle; sum all pairwise chord
+lengths; normalize by the maximum (equally spaced onsets). Score 1.0 means maximally even.
+
+**Syncopation** (Keith 1991): Metric weight of position `i` is `n` for the downbeat
+(`i=0`) and the largest power of 2 dividing `i` for `i>0`. A syncopation occurs when
+an onset at a weak beat is followed by a rest at a stronger beat; the score accumulates
+the weight difference.
+
+**Rhythmic oddity** (Pressing 1983): True if no two onsets are diametrically opposite
+on the rhythm circle (no pair partitions the cycle into two equal halves).
+
+**Offbeatness** (Toussaint): For a cycle of n pulses, position p is off-beat iff
+gcd(p, n) == 1 -- equivalently, p is not covered by any regular subdivision of the
+cycle (union of {k*n/d} for proper divisors d of n). Offbeatness is the count of onsets
+at such positions. Both characterizations produce identical off-beat sets, verified for
+n in 2..64.
+
+**Inter-onset intervals**: The sequence of gaps (in pulses) between consecutive onsets
+around the cycle, wrapping from the last onset back to the first. Always sums to n.
+
+## References
+
+- Bjorklund, E. (2003). The theory of rep-rate pattern generation in the SNS timing system.
+- Toussaint, G. (2005). The Euclidean algorithm generates traditional musical rhythms. BRIDGES.
+- Keith, M. (1991). From Polychords to Polya: Adventures in Musical Combinatorics.
+- Pressing, J. (1983). Cognitive isomorphisms between pitch and rhythm in world musics. Studies in Music.
+
+## License
+
+MIT. Copyright (c) 2026 Amaar Chughtai.

euclidean_rhythm-0.2.0/SECURITY.md

@@ -0,0 +1,18 @@
+# Security Policy
+
+## Scope
+
+`euclidean-rhythm` is a pure computation library with no runtime dependencies, no network
+access, and no file system access. The attack surface is limited to incorrect results from
+malformed input, which the library guards against with explicit validation.
+
+## Reporting a vulnerability
+
+If you find a security issue, please email amaar2cool@gmail.com with details and steps to
+reproduce. Please do not open a public issue for security reports. You can expect an
+initial response within a few days.
+
+## Supported versions
+
+The latest published minor version receives fixes. Pre-1.0 releases may introduce breaking
+changes in minor versions, as allowed by semantic versioning.