greenwood 0.1.0__tar.gz

greenwood-0.1.0/.claude/skills/release-notes/SKILL.md

@@ -0,0 +1,205 @@
+---
+name: release-notes
+description: Generate polished release notes for Greenwood from GitHub PR/commit data. Creates an opening summary paragraph and well-organized sections for features, enhancements, fixes, and docs.
+argument-hint: "[GitHub release changelog text or PR list]"
+---
+
+# Greenwood Release Notes Workflow
+
+Generate professional release notes from raw GitHub release data. The input is: $ARGUMENTS
+
+## Output Format
+
+Release notes follow this structure:
+
+```markdown
+## v{VERSION}
+
+_{DATE}_ · [GitHub](https://github.com/rich-iannone/greenwood/releases/tag/v{VERSION})
+
+{SUMMARY_PARAGRAPH}
+
+### New Features
+
+- **{Feature name}** — {Brief description of what it does}. (#{PR_NUMBER})
+
+### Enhancements
+
+- {Description of improvement}. (#{PR_NUMBER})
+
+### Bug Fixes
+
+- {Description of what was fixed}. (#{PR_NUMBER})
+
+### Documentation
+
+- {Description of docs change}. (#{PR_NUMBER})
+```
+
+## Presenting the Final Output
+
+Always wrap the final release notes in **4 backticks** (not 3) to facilitate easy copy/paste in VS Code:
+
+`````markdown
+```
+## v{VERSION}
+
+...release notes content...
+```
+`````
+
+This prevents issues when the release notes themselves contain triple-backtick code blocks.
+
+## Step 1: Categorize the Changes
+
+Parse the input and categorize each PR by its prefix:
+
+| Prefix   | Category                | Section                          |
+| -------- | ----------------------- | -------------------------------- |
+| `feat:`  | New functionality       | **New Features**                 |
+| `enh:`   | Improvement to existing | **Enhancements**                 |
+| `fix:`   | Bug fix                 | **Bug Fixes**                    |
+| `doc:`   | Documentation only      | **Documentation**                |
+| `chore:` | Maintenance/tooling     | **Maintenance** (if significant) |
+| `test:`  | Test additions          | Usually omit unless significant  |
+
+If no prefix, infer from the PR title keywords:
+
+- "add support for", "new", "implement" → New Features
+- "improve", "update", "enhance" → Enhancements
+- "fix", "correct", "resolve" → Bug Fixes
+- "document", "docs", "readme" → Documentation
+
+## Step 2: Research Feature Details
+
+For each **New Feature**, gather context to write accurate descriptions:
+
+1. Search the codebase for the feature implementation
+2. Check for user-facing documentation (in `user_guide/` or `recipes/`)
+3. Look at config options added (in `config.py`)
+4. Identify the main benefit to users
+
+Key questions to answer:
+
+- What problem does this solve?
+- What's the user-facing command or config option?
+- Does it require configuration or work automatically?
+
+## Step 3: Write the Summary Paragraph
+
+The opening paragraph should:
+
+1. **State the release theme** in broad terms (e.g., "improvements to site presentation and SEO")
+2. **Highlight 3-5 major features** by name
+3. **Mention key user benefits** (e.g., "catch grammar issues locally", "better mobile experience")
+4. Be **2-4 sentences** — concise but informative
+
+Example:
+
+> Greenwood v0.2 brings significant improvements to site presentation, content quality, and SEO. This release introduces styled tooltips throughout, responsive tables that work on any screen size, Mermaid diagram support with dark mode compatibility, and comprehensive SEO features including automatic sitemap generation. A new `proofread` command powered by Harper helps catch grammar and spelling issues locally. Pages can now display creation/modification metadata, and `ROADMAP.md` files are automatically integrated into your documentation.
+
+## Step 4: Format Each Entry
+
+### New Features Format
+
+Use bold for the feature name, em-dash separator, and end with PR number:
+
+```markdown
+- **{Feature name}** — {What it does and why it's useful}. (#{PR})
+```
+
+Examples:
+
+- **ROADMAP.md support** — Project roadmap files are now auto-detected and integrated into the documentation site with proper navigation links. (#42)
+- **Harper proofreading** — New `great-docs proofread` command for local grammar and spelling checks with a built-in technical dictionary and multiple output formats. (#48)
+
+### Enhancements Format
+
+Simpler format without bold feature name:
+
+```markdown
+- {What was improved and how}. (#{PR})
+```
+
+Example:
+
+- Markdown is now supported in announcement banner text, allowing links and formatting. (#35)
+
+### Bug Fixes Format
+
+Describe what was wrong and that it's now fixed:
+
+```markdown
+- {What was broken} was fixed. (#{PR})
+```
+
+Or describe the improvement made:
+
+```markdown
+- {Component} now {correct behavior}. (#{PR})
+```
+
+Examples:
+
+- Python version is now auto-detected for GitHub deployment workflows. (#40)
+- Images in README.md files are now properly copied to the output directory. (#57)
+
+### Documentation Format
+
+Brief description of what was documented:
+
+```markdown
+- Added documentation on {topic}. (#{PR})
+```
+
+## Step 5: Order and Polish
+
+### Section Order
+
+1. New Features (most important)
+2. Enhancements
+3. Bug Fixes
+4. Documentation
+5. Maintenance (only if significant)
+
+### Within Each Section
+
+Order entries by:
+
+1. **User impact** — Most impactful first
+2. **Related features** — Group related items together
+
+### Final Checklist
+
+- [ ] Summary paragraph captures the release theme
+- [ ] All PRs are categorized
+- [ ] Feature descriptions explain user benefit
+- [ ] Consistent formatting (bold, em-dash, periods, PR numbers)
+- [ ] No duplicate information between summary and entries
+- [ ] Date is correct (use current date if releasing today)
+
+## Section Templates by Release Type
+
+### Major Release (new capabilities)
+
+Focus on New Features section. Summary emphasizes what users can now do.
+
+### Minor Release (improvements)
+
+Balance New Features and Enhancements. Summary emphasizes improved experience.
+
+### Patch Release (fixes only)
+
+May omit New Features section entirely. Brief summary:
+
+> Greenwood v{X.Y.Z} is a maintenance release with bug fixes and stability improvements.
+
+### Packaging-Only Release
+
+> Packaging fix release — no functional changes from v{PREVIOUS}.
+>
+> ### Changes
+>
+> - {What changed in packaging}. (#{PR})
+>
+> See [v{PREVIOUS} release notes](...) for all features and fixes in this release.

greenwood-0.1.0/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,83 @@
+# Contributor Covenant 3.0 Code of Conduct
+
+## Our Pledge
+
+We pledge to make our community welcoming, safe, and equitable for all.
+
+We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
+
+## Encouraged Behaviors
+
+While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
+
+With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
+
+1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
+2. Engaging **kindly and honestly** with others.
+3. Respecting **different viewpoints** and experiences.
+4. **Taking responsibility** for our actions and contributions.
+5. Gracefully giving and accepting **constructive feedback**.
+6. Committing to **repairing harm** when it occurs.
+7. Behaving in other ways that promote and sustain the **well-being of our community**.
+
+## Restricted Behaviors
+
+We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
+
+1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
+2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
+3. **Stereotyping or discrimination.** Characterizing anyone's personality or behavior on the basis of immutable identities or traits.
+4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
+5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
+6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
+7. Behaving in other ways that **threaten the well-being** of our community.
+
+### Other Restrictions
+
+1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
+2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
+3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
+4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
+
+## Reporting an Issue
+
+Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
+
+When an incident does occur, it is important to report it promptly. To report a possible violation, please contact the project maintainers at riannone@me.com.
+
+Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
+
+## Addressing and Repairing Harm
+
+If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
+
+1. Warning
+   1. Event: A violation involving a single incident or series of incidents.
+   2. Consequence: A private, written warning from the Community Moderators.
+   3. Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
+2. Temporarily Limited Activities
+   1. Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
+   2. Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
+   3. Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
+3. Temporary Suspension
+   1. Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
+   2. Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
+   3. Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
+4. Permanent Ban
+   1. Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
+   2. Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
+   3. Repair: There is no possible repair in cases of this severity.
+
+This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
+
+Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
+
+For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla's code of conduct team](https://github.com/mozilla/inclusion).

greenwood-0.1.0/.github/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing to Greenwood
+
+Thanks for your interest in improving Greenwood! This project is in active early
+development (see [`ROADMAP.md`](../ROADMAP.md)). Contributions of code, tests, docs, and
+R-parity fixtures are all welcome.
+
+## Development setup
+
+```bash
+git clone https://github.com/rich-iannone/greenwood.git
+cd greenwood
+python -m venv .venv && source .venv/bin/activate
+make install          # pip install -e ".[dev]"
+pre-commit install    # optional but recommended
+```
+
+## The check gate
+
+Before opening a pull request, make sure the full gate is green:
+
+```bash
+make check            # ruff format + ruff check + pyright + pytest
+```
+
+Individual targets: `make lint`, `make type-check`, `make test`, `make test-rparity`.
+Run `make help` for the full list.
+
+## House conventions
+
+- **R-validated numerics.** Correctness to tolerance against R's `survival` (and
+`cmprsk`/`flexsurv`/`riskRegression`/`mstate` for specialized estimators) is the brand.
+Regenerate fixtures with `Rscript scripts/regenerate_r_fixtures.R` and validate with
+`make test-rparity`.
+- **Narwhals-native.** Never assume pandas; write data handling against Narwhals and drop
+to NumPy only inside numeric kernels.
+- **Typed & deterministic.** Full type hints (`py.typed`), `pyright` clean, byte-identical
+output for identical inputs.
+- **Prose style.**  Docstrings use Quarto/Markdown, not RST: single backticks for inline
+code, numpydoc section headers (`Parameters`, `Returns`).
+- Implementation lives in underscore-prefixed private modules; the public surface is
+curated explicitly in `__init__.py`.
+
+## Pull requests
+
+- Keep PRs focused and add tests for new behavior (target >=90% coverage).
+- For new/changed statistics, add or update R-parity fixtures.
+- Update docs (docstrings, `user_guide/`) alongside code.
+
+By contributing you agree that your contributions are licensed under the MIT License.

greenwood-0.1.0/.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Report incorrect behavior or a crash
+title: "[bug] "
+labels: bug
+---
+
+## Describe the bug
+
+A clear and concise description of what went wrong.
+
+## Reproducible example
+
+A minimal, self-contained snippet that triggers the problem:
+
+```python
+import greenwood as gw
+# ...
+```
+
+## Expected behavior
+
+What you expected to happen. If this is a numeric-correctness issue, include the reference
+value (e.g. from R `survival`) you expected.
+
+## Environment
+
+- Greenwood version:
+- Python version:
+- Dataframe backend + version (pandas / Polars / ...):
+- OS:
+
+## Additional context
+
+Anything else that helps, such as a full traceback or a plot.

greenwood-0.1.0/.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Suggest a new capability or improvement
+title: "[feature] "
+labels: enhancement
+---
+
+## What problem would this solve?
+
+Describe the use case or gap. If there is prior art (R `survival`, lifelines,
+scikit-survival, flexsurv, ...), link or name it.
+
+## Proposed API / behavior
+
+Sketch how it might look:
+
+```python
+import greenwood as gw
+# ...
+```
+
+## Roadmap fit
+
+Is this related to an existing phase in [`ROADMAP.md`](../../ROADMAP.md)?
+
+## Alternatives considered
+
+Other approaches you thought about, and why this one.

greenwood-0.1.0/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,25 @@
+---
+name: Question
+about: Ask how to do something with Greenwood
+title: "[question] "
+labels: question
+---
+
+## Your question
+
+What are you trying to accomplish?
+
+## What you've tried
+
+Any code, docs, or search you have already looked at:
+
+```python
+import greenwood as gw
+# ...
+```
+
+## Environment (if relevant)
+
+- greenwood version:
+- Python version:
+- Dataframe backend:

greenwood-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+# Summary
+
+Thank you for contributing to Greenwood! Please explain the context and purpose of your
+contribution, and list the changes made to the code or docs.
+
+# Related GitHub Issues and PRs
+
+- Ref: #
+
+# Checklist
+
+- [ ] `make check` passes (ruff, pyright, pytest).
+- [ ] I have added tests for any new functionality.
+- [ ] For new/changed statistics, I have added or updated R-parity fixtures.
+- [ ] I have updated docs (docstrings and/or `user_guide/`) as needed.

greenwood-0.1.0/.github/SECURITY.md

@@ -0,0 +1,31 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you believe you have found a security vulnerability in this project, we encourage you to report it responsibly. Please do not open a public issue. Instead, please use the Report a vulnerability function available via the security tab.
+
+Your report should include (if possible):
+
+- a clear description of the vulnerability, including impact and affected versions
+- steps to reproduce the issue
+- any relevant code snippets, logs, or proof-of-concept exploit
+- suggested remediation or mitigation, if known
+
+We aim to acknowledge receipt of your report within 7 business days and provide an update on remediation progress within 14 business days.
+
+## Coordinated Disclosure
+
+We follow a coordinated disclosure approach. Once the issue is confirmed and a fix is ready, we will:
+
+- notify you prior to public disclosure
+- credit you in the release notes (unless you prefer to remain anonymous)
+- publish a security advisory and update affected versions
+- if severe enough, assist with publishing a CVE
+
+## Security Best Practices
+
+To minimize your exposure:
+
+- always use the latest stable release
+- avoid running our tools with unnecessary privileges
+- review and validate third-party extensions or plugins before use

greenwood-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,90 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  release:
+    types: [published]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # setuptools_scm needs full history/tags
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      - name: Ruff check
+        run: ruff check greenwood tests
+      - name: Ruff format check
+        run: ruff format --check greenwood tests
+      - name: Pyright
+        run: pyright greenwood
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      - name: Run tests
+        # The R-parity suite compares against checked-in fixtures, so it needs no
+        # R toolchain here; R is only used offline to regenerate those fixtures.
+        run: pytest tests
+
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    if: github.event_name == 'release'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build sdist and wheel
+        run: |
+          pip install build
+          python -m build --sdist --wheel
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release'
+    environment:
+      name: pypi
+      url: https://pypi.org/project/greenwood/
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

greenwood-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,61 @@
+name: CI Docs
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build-docs:
+    name: "Build Docs"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # full history for accurate page timestamps
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install package and docs dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[docs]"
+          python -m pip install git+https://github.com/posit-dev/great-docs.git@main
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+      - name: Build docs
+        run: great-docs build
+      - name: Save docs artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-html
+          path: great-docs/_site
+          include-hidden-files: true
+          
+  publish-docs:
+    name: "Publish Docs"
+    runs-on: ubuntu-latest
+    needs: "build-docs"
+    if: github.ref == 'refs/heads/main'
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/download-artifact@v7
+        with:
+          name: docs-html
+          path: great-docs/_site
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: great-docs/_site
+          include-hidden-files: true
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5