statwarrant 0.5.0__tar.gz

statwarrant-0.5.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,30 @@
+name: Bug report
+description: A wrong number, a crash, or output that contradicts itself.
+title: "[Bug] "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Everything here is public: do not paste confidential or unpublished data. Security problems:
+        report them privately (see SECURITY.md), not here.
+  - type: textarea
+    id: what
+    attributes:
+      label: What happened, and what did you expect?
+    validations:
+      required: true
+  - type: textarea
+    id: code
+    attributes:
+      label: Minimal code to reproduce
+      render: python
+    validations:
+      required: true
+  - type: input
+    id: versions
+    attributes:
+      label: Versions
+      placeholder: statwarrant 0.5.0, Python 3.12, SciPy 1.14, Windows 11
+    validations:
+      required: true

statwarrant-0.5.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Questions and ideas
+    url: https://github.com/Haifawaeedd/statwarrant/discussions
+    about: Ask how to use statwarrant or suggest a direction.

statwarrant-0.5.0/.github/ISSUE_TEMPLATE/feedback.yml

@@ -0,0 +1,75 @@
+name: Feedback
+description: Tell us how statwarrant worked for you. Takes about 3 minutes.
+title: "[Feedback] "
+labels: ["feedback"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for trying statwarrant. Everything you write here is public and is used to improve the software.
+        Please do not paste confidential or unpublished data.
+  - type: dropdown
+    id: role
+    attributes:
+      label: What best describes you?
+      options:
+        - Master's student
+        - PhD student
+        - Researcher or academic
+        - Data scientist or ML engineer
+        - Teacher of statistics
+        - Other
+    validations:
+      required: true
+  - type: input
+    id: field
+    attributes:
+      label: Your field
+      placeholder: e.g. education, psychology, NLP, public health
+  - type: textarea
+    id: use
+    attributes:
+      label: What did you use it for?
+      description: The kind of comparison and where the numbers came from (scipy, statsmodels, a paper, model scores...).
+    validations:
+      required: true
+  - type: dropdown
+    id: changed
+    attributes:
+      label: Did the output change what you would have written?
+      options:
+        - "Yes, it stopped a claim I would have made"
+        - "Yes, it gave me better wording"
+        - "No, it agreed with what I would have written"
+        - "No, and I think it was wrong"
+    validations:
+      required: true
+  - type: dropdown
+    id: clarity
+    attributes:
+      label: How clear was the output?
+      options:
+        - "5 - very clear"
+        - "4"
+        - "3"
+        - "2"
+        - "1 - confusing"
+    validations:
+      required: true
+  - type: textarea
+    id: misjudged
+    attributes:
+      label: A sentence the linter handled wrongly (if any)
+      description: Paste the sentence, the warnings you got, and what you expected (a false warning, or a misreading it missed). These reports are the most useful.
+      render: text
+  - type: textarea
+    id: missing
+    attributes:
+      label: What was missing or getting in the way?
+  - type: checkboxes
+    id: public
+    attributes:
+      label: Public feedback
+      options:
+        - label: I understand this feedback is public and will be used to improve statwarrant.
+          required: true

statwarrant-0.5.0/.github/ISSUE_TEMPLATE/linter.yml

@@ -0,0 +1,57 @@
+name: A sentence the linter got wrong
+description: A false warning, or a misreading it missed. About one minute; the most useful report you can send.
+title: "[Linter] "
+labels: ["linter", "feedback"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you. These reports are how the sentence checker improves. Everything here is public:
+        do not paste confidential or unpublished text. A rephrased or invented sentence with the same
+        structure is fine.
+  - type: textarea
+    id: sentence
+    attributes:
+      label: The sentence
+      placeholder: "Neither a difference from zero nor equivalence was established."
+    validations:
+      required: true
+  - type: textarea
+    id: result
+    attributes:
+      label: The result it was checked against
+      description: The declare(...) and analyze(...) call, or the estimate, SE (or CI), df and SESOI.
+      render: python
+      placeholder: |
+        plan = sw.declare(sesoi=0.2, sesoi_source="...", units="points")
+        res = plan.analyze(estimate=0.15, se=0.1, df=80)
+    validations:
+      required: true
+  - type: dropdown
+    id: kind
+    attributes:
+      label: What went wrong?
+      options:
+        - "False warning: the sentence is fine but got a warning"
+        - "Missed problem: the sentence misreads the result but got no warning"
+        - "Right warning, wrong reason or misleading explanation"
+        - "Other"
+    validations:
+      required: true
+  - type: textarea
+    id: output
+    attributes:
+      label: What statwarrant printed
+      description: Paste the output of print(res.check(sentence)).
+      render: text
+  - type: textarea
+    id: expected
+    attributes:
+      label: What you expected, and why
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: statwarrant version
+      placeholder: "0.5.0 (python -c \"import statwarrant; print(statwarrant.__version__)\")"

statwarrant-0.5.0/.github/workflows/release.yml

@@ -0,0 +1,94 @@
+name: release
+
+# Manual publishing with PyPI Trusted Publishing (no API token in the repository).
+# Nothing is published automatically: only the repository owner can run it, by hand, typing
+# a confirmation; PyPI uploads must run from a version tag such as v0.5.0.
+#
+# Naming an environment below does NOT by itself require approval, and this workflow cannot
+# check the environment's settings. Before configuring any trusted publisher:
+# 1. GitHub: Settings -> Environments -> create "testpypi" and "pypi"; for "pypi" add
+#    yourself as a required reviewer and restrict it to tags v*, so every PyPI upload waits
+#    for your approval.
+# 2. test.pypi.org and pypi.org: Account -> Publishing -> add a pending publisher with
+#    project statwarrant, owner Haifawaeedd, repository statwarrant, workflow release.yml,
+#    and environment testpypi (on TestPyPI) or pypi (on PyPI).
+
+on:
+  workflow_dispatch:
+    inputs:
+      target:
+        description: "Where to publish"
+        type: choice
+        options: [testpypi, pypi]
+        default: testpypi
+      confirm:
+        description: "Type: publish statwarrant VERSION to TARGET (for example: publish statwarrant 0.5.0 to testpypi)"
+        required: true
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    if: github.actor == github.repository_owner
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Check the version and the confirmation
+        env:
+          TARGET: ${{ inputs.target }}
+          CONFIRM: ${{ inputs.confirm }}
+        run: |
+          version=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          echo "version $version, ref ${GITHUB_REF}"
+          test "$CONFIRM" = "publish statwarrant $version to $TARGET" || { echo "confirmation does not match"; exit 1; }
+          if [ "$TARGET" = "pypi" ]; then
+            test "${GITHUB_REF}" = "refs/tags/v$version" || { echo "PyPI uploads must run from tag v$version"; exit 1; }
+            case "$version" in *dev*) echo "development versions are not uploaded to PyPI"; exit 1;; esac
+          fi
+      - name: Build and check
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build
+          twine check --strict dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  testpypi:
+    if: inputs.target == 'testpypi'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/statwarrant/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  pypi:
+    if: inputs.target == 'pypi'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/statwarrant/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

statwarrant-0.5.0/.github/workflows/tests.yml

@@ -0,0 +1,83 @@
+name: tests
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[test]" pytest-cov
+      - name: Test with coverage
+        run: pytest --cov=statwarrant --cov-report=term-missing
+
+  other-platforms:
+    # pip install and the full suite on macOS and Windows.
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[test]"
+      - name: Test
+        run: pytest
+
+  oldest-dependencies:
+    # The lowest versions pyproject.toml promises to support.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install oldest supported NumPy and SciPy
+        run: |
+          python -m pip install --upgrade pip
+          pip install "numpy==1.22.4" "scipy==1.11.4" "statsmodels==0.14.0" "pandas<2.1" pytest hypothesis
+          pip install --no-deps -e .
+      - name: Test
+        run: pytest
+
+  package:
+    # Build the sdist and wheel, then install the wheel in a clean environment.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build
+          twine check dist/*
+      - name: Install the wheel outside the source tree and test it
+        run: |
+          python -m venv /tmp/clean
+          /tmp/clean/bin/pip install dist/*.whl pytest hypothesis statsmodels
+          cp -r tests /tmp/wheel-tests
+          cd /tmp && /tmp/clean/bin/python -c "import statwarrant, sys; print(statwarrant.__version__, statwarrant.__file__)"
+          cd /tmp && /tmp/clean/bin/python -m pytest -q /tmp/wheel-tests -p no:cacheprovider --rootdir /tmp/wheel-tests

statwarrant-0.5.0/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.pytest_cache/
+.hypothesis/
+.coverage