typeshed_stats 24.5.21__tar.gz

typeshed_stats-24.5.21/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*.{py,md,yml,yaml,toml,json,gitattributes}]
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+
+[*.{py,toml}]
+indent_size = 4
+
+[*.{yml,yaml,json}]
+indent_size = 2

typeshed_stats-24.5.21/.gitattributes

@@ -0,0 +1,2 @@
+examples/** linguist-generated=true
+stats_website/**.md linguist-language=jinja

typeshed_stats-24.5.21/.github/renovate.json5

@@ -0,0 +1,23 @@
+{
+  $schema: "https://docs.renovatebot.com/renovate-schema.json",
+  extends: ["config:recommended"],
+  dependencyDashboard: true,
+  separateMajorMinor: false,
+  "pre-commit": {
+    enabled: true,
+  },
+  packageRules: [
+    {
+      groupName: "GitHub Actions",
+      matchManagers: ["github-actions"],
+      description: "Quarterly update of GitHub Action dependencies",
+    },
+    {
+      groupName: "most test/lint dependencies",
+      matchManagers: ["pep621", "pre-commit"],
+      description: "Quarterly update of most test/lint dependencies",
+    },
+  ],
+  schedule: ["every 3 months on the first day of the month"],
+  suppressNotifications: ["prEditedNotification"],
+}

typeshed_stats-24.5.21/.github/workflows/check-requirements.yml

@@ -0,0 +1,64 @@
+name: Check requirements
+
+on:
+  push:
+    branches: main
+    paths:
+      - ".github/workflows/check-requirements.yml"
+      - "pyproject.toml"
+  pull_request:
+    paths:
+      - ".github/workflows/check-requirements.yml"
+      - "pyproject.toml"
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+permissions:
+  contents: read
+
+env:
+  FORCE_COLOR: 1 # Request colored output from CLI tools supporting it
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  check-requirements:
+    name: Check requirements can all be installed together
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Check requirements can all be installed together
+        run: uv pip install -e '.[dev]' --system
+
+  create-issue-on-failure:
+    name: Create an issue if daily requirements check failed
+    runs-on: ubuntu-latest
+    needs: check-requirements
+    if: >-
+      ${{
+        github.repository == 'AlexWaygood/typeshed-stats'
+        && always()
+        && github.event_name == 'schedule'
+        && needs.check-requirements.result == 'failure'
+      }}
+    permissions:
+      issues: write
+    steps:
+      - uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            await github.rest.issues.create({
+              owner: "AlexWaygood",
+              repo: "typeshed-stats",
+              title: `Daily requirements check failed on ${new Date().toDateString()}`,
+              body: "Runs are listed here: https://github.com/AlexWaygood/typeshed-stats/actions/workflows/check-requirements.yml",
+            })

typeshed_stats-24.5.21/.github/workflows/publish.yml

@@ -0,0 +1,52 @@
+# Based on
+# https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+name: Publish Python distributions to PyPI
+
+on:
+  push:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * 0"
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python distributions to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      # needed for PyPI trusted publishing
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - run: uv pip install build --system
+      - run: uv pip freeze
+      - if: ${{ github.event_name != 'push' }}
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: |
+          DATE=$(date '+%y.%-m.%-d')
+          echo $DATE
+          git config --global user.name releasebot
+          git config --global user.email ""
+          git tag -a $DATE -m ""
+          git push --tags
+          gh release create $DATE --notes "Automated weekly release"
+      - name: Build a binary wheel and a source tarball
+        run: python -m build --outdir dist/ .
+      - name: Publish distribution to PyPI
+        if: ${{ github.event_name != 'push' || startsWith(github.ref, 'refs/tags') }}
+        uses: pypa/gh-action-pypi-publish@release/v1

typeshed_stats-24.5.21/.github/workflows/regen-examples-and-docs.yml

@@ -0,0 +1,85 @@
+name: Regenerate examples and docs
+
+on:
+  schedule:
+    - cron: "0 */12 * * *"
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - "tests/**"
+      - "examples/**"
+      - "**.json"
+      - "**.csv"
+      - "**.html"
+  workflow_dispatch:
+
+jobs:
+  regen_examples_and_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: git config
+        run: |
+          git config --global user.name statsabot
+          git config --global user.email ''
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - uses: hynek/setup-cached-uv@v1
+      - run: uv pip install -e .[docs] --system
+      - run: uv pip freeze
+      - name: Regenerate examples and docs
+        id: regen
+        run: python scripts/regenerate.py --download-typeshed
+      - name: Check the generated files with pre-commit
+        id: lint
+        uses: pre-commit/action@v3.0.1
+      - name: Commit and push the changes
+        id: commit
+        if: >-
+          ${{
+            github.repository == 'AlexWaygood/typeshed-stats'
+            && always()
+            && steps.regen.outcome == 'success'
+            && steps.lint.outcome == 'success'
+          }}
+        run: |
+          git add .
+          git diff --staged --quiet || git commit -m "👷 Automated regeneration of examples and docs"
+          git push
+      - name: Deploy docs
+        if: >-
+          ${{
+            github.repository == 'AlexWaygood/typeshed-stats'
+            && always()
+            && steps.regen.outcome == 'success'
+            && steps.lint.outcome == 'success'
+            && steps.commit.outcome == 'success'
+          }}
+        run: mkdocs gh-deploy -m "🚀 Deploying {sha} with MkDocs {version}" --force
+
+  create-issue-on-failure:
+    name: Create an issue if the automated regeneration failed
+    runs-on: ubuntu-latest
+    needs: [regen_examples_and_docs]
+    if: >-
+      ${{
+        github.repository == 'AlexWaygood/typeshed-stats'
+        && always()
+        && github.event_name == 'schedule'
+        && needs.regen_examples_and_docs.result == 'failure'
+      }}
+    permissions:
+      issues: write
+    steps:
+      - uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            await github.rest.issues.create({
+              owner: "AlexWaygood",
+              repo: "typeshed-stats",
+              title: `Automated regeneration of examples failed on ${new Date().toDateString()}`,
+              body: "Runs are listed here: https://github.com/AlexWaygood/typeshed-stats/actions/workflows/regen-examples-and-docs.yml",
+            })

typeshed_stats-24.5.21/.github/workflows/test-website.yml

@@ -0,0 +1,38 @@
+name: Test website generation
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths-ignore:
+      - "tests/**"
+      - "examples/**"
+      - "**.json"
+      - "**.csv"
+      - "**.html"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  test-website:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - uses: hynek/setup-cached-uv@v1
+      - run: uv pip install -e .[docs] --system
+      - run: uv pip freeze
+      - name: Regenerate examples and docs
+        run: python scripts/regenerate.py --download-typeshed
+      - name: Check the generated files with pre-commit
+        uses: pre-commit/action@v3.0.1
+      - name: Build docs
+        run: mkdocs build --strict
+      - name: Upload docs
+        uses: actions/upload-artifact@v4
+        with:
+          name: doc-html
+          path: site

typeshed_stats-24.5.21/.github/workflows/test.yml

@@ -0,0 +1,92 @@
+name: tests
+
+on:
+  push:
+    branches: main
+    paths-ignore:
+      - "examples/**"
+      - "scripts/**"
+      - "stats_website/**"
+      - "**.md"
+      - "**.json"
+      - "**.csv"
+      - "**.html"
+  pull_request:
+    paths-ignore:
+      - "examples/**"
+      - "scripts/**"
+      - "stats_website/**"
+      - "**.md"
+      - "**.json"
+      - "**.csv"
+      - "**.html"
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+permissions:
+  contents: read
+
+env:
+  FORCE_COLOR: 1 # Request colored output from CLI tools supporting it
+  PY_COLORS: 1 # Recognized by the `py` package, dependency of `pytest`
+  # TERM is needed for FORCE_COLOR to work on mypy on Ubuntu,
+  # see https://github.com/python/mypy/issues/13817
+  TERM: xterm-256color
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  pytest-tests:
+    name: Run tests with pytest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+      - uses: hynek/setup-cached-uv@v1
+      - name: Install dependencies
+        run: uv pip install -e ".[pytest]" --system
+      - run: uv pip freeze
+      - name: Run tests under coverage
+        shell: bash
+        run: |
+          coverage run -m pytest --doctest-modules
+          coverage report --no-skip-covered
+
+  create-issue-on-failure:
+    name: Create an issue if daily test failed
+    runs-on: ubuntu-latest
+    needs: pytest-tests
+    if: >-
+      ${{
+        github.repository == 'AlexWaygood/typeshed-stats'
+        && always()
+        && github.event_name == 'schedule'
+        && needs.pytest-tests.result == 'failure'
+      }}
+    permissions:
+      issues: write
+    steps:
+      - uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            await github.rest.issues.create({
+              owner: "AlexWaygood",
+              repo: "typeshed-stats",
+              title: `Daily test failed on ${new Date().toDateString()}`,
+              body: "Runs are listed here: https://github.com/AlexWaygood/typeshed-stats/actions/workflows/test.yml",
+            })

typeshed_stats-24.5.21/.github/workflows/typecheck.yml

@@ -0,0 +1,88 @@
+name: Typecheck
+
+on:
+  push:
+    branches: main
+    paths-ignore:
+      - "**.json"
+      - "**.md"
+      - "**.csv"
+      - "**.html"
+  pull_request:
+    paths-ignore:
+      - "**.json"
+      - "**.md"
+      - "**.csv"
+      - "**.html"
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+permissions:
+  contents: read
+
+env:
+  FORCE_COLOR: 1 # Request colored output from CLI tools supporting it
+  TERM: xterm-256color # needed for FORCE_COLOR to work on mypy on Ubuntu, see https://github.com/python/mypy/issues/13817
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  mypy:
+    name: Check code with mypy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - uses: hynek/setup-cached-uv@v1
+      - run: uv pip install -e ".[typecheck]" --system
+      - run: uv pip freeze
+      - run: mypy
+
+  pyright:
+    name: Run pyright on the codebase
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - uses: hynek/setup-cached-uv@v1
+      - run: uv pip install -e ".[typecheck]" --system
+      - run: uv pip freeze
+      - name: Run pyright
+        uses: jakebailey/pyright-action@v2
+        with:
+          version: "1.1.331"
+
+  create-issue-on-failure:
+    name: Create an issue if daily typecheck failed
+    runs-on: ubuntu-latest
+    needs: [mypy, pyright]
+    if: >-
+      ${{
+        github.repository == 'AlexWaygood/typeshed-stats'
+        && always()
+        && github.event_name == 'schedule'
+        && (
+          needs.mypy.result == 'failure'
+          || needs.pyright.result == 'failure'
+        )
+      }}
+    permissions:
+      issues: write
+    steps:
+      - uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            await github.rest.issues.create({
+              owner: "AlexWaygood",
+              repo: "typeshed-stats",
+              title: `Daily typecheck failed on ${new Date().toDateString()}`,
+              body: "Runs are listed here: https://github.com/AlexWaygood/typeshed-stats/actions/workflows/typecheck.yml",
+            })

typeshed_stats-24.5.21/.gitignore

@@ -0,0 +1,78 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+/env/
+/build/
+/develop-eggs/
+/dist/
+/downloads/
+/eggs/
+/lib/
+/lib64/
+/parts/
+/sdist/
+/var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+stubtest-output*
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Local utility scripts
+analyze.py
+
+# Editor backup files
+*~
+.*.sw?
+.vscode/
+.idea/
+
+# virtual environments
+.venv*/
+venv/
+env/
+
+# Mypy cache
+.mypy_cache/
+
+# mkdocs documentation
+site/
+
+# autogenerated by hatch-vcs at build time
+src/typeshed_stats/_version.py

typeshed_stats-24.5.21/.markdownlint.yaml

@@ -0,0 +1,26 @@
+# Unordered list style
+MD004:
+  style: "dash"
+
+# Unordered list indentation
+MD007:
+  indent: 4
+
+# Ordered list item prefix
+MD029:
+  style: "one"
+
+# code block style
+MD046:
+  style: "fenced"
+
+# code fence style
+MD048:
+  style: "backtick"
+
+# Disabled rules
+no-inline-html: false
+first-line-h1: false
+no-duplicate-heading: false
+line-length: false
+reference-links-images: false

typeshed_stats-24.5.21/.pre-commit-config.yaml

@@ -0,0 +1,54 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0 # must match pyproject.toml
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: name-tests-test
+        args: [--pytest-test-first]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5 # must match pyproject.toml
+    hooks:
+      - id: ruff
+      - id: ruff-format
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.16.0 # must match pyproject.toml
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==24.3.0]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+  - repo: https://github.com/alan-turing-institute/CleverCSV-pre-commit
+    rev: v0.8.2
+    hooks:
+      - id: clevercsv-standardize
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.39.0
+    hooks:
+      - id: markdownlint-fix
+        args: ["--ignore", "stats_website/.snippets"]
+      - id: markdownlint
+        args: ["--ignore", "stats_website/.snippets"]
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        exclude: "^examples/.*"
+        exclude_types: ["markdown"]
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+
+ci:
+  autofix_commit_msg: "[pre-commit.ci] auto fixes from pre-commit.com hooks"
+  autofix_prs: true
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
+  autoupdate_schedule: quarterly
+  submodules: false

typeshed_stats-24.5.21/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+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.