typeshed_stats 22.11.0__tar.gz

typeshed_stats-22.11.0/.coveragerc

@@ -0,0 +1,2 @@
+[run]
+relative_files = True

typeshed_stats-22.11.0/.editorconfig

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

typeshed_stats-22.11.0/.flake8

@@ -0,0 +1,32 @@
+# Rules that are ignored:
+#
+# The following rule now goes against PEP8:
+#       W503 line break before binary operator
+#
+# The following rules are incompatible with or largely enforced by black:
+#       B950 Line too long (flake8-bugbear equivalent of E501)
+#       E203 whitespace before
+#       E501 line too long
+#       W291 trailing whitespace
+#       W293 blank line contains whitespace
+#
+# I disagree with these stylistic lints from flake8-pytest-style and flake8-simplify
+#       SIM905
+#       PT004
+#       PT005
+
+[flake8]
+max-line-length = 80
+max-complexity = 12
+ignore =
+  B950, E203, E501, W503, W291, W293, SIM905, PT004, PT005
+
+# flake8-noqa config
+noqa-require-code = true
+
+# flake8-pytest-style config
+pytest-fixture-no-parentheses = true
+pytest-mark-no-parentheses = true
+
+# I don't care about docstrings for test files or functions
+per-file-ignores = tests/*.py : D

typeshed_stats-22.11.0/.gitattributes

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

typeshed_stats-22.11.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"

typeshed_stats-22.11.0/.github/workflows/check.yml

@@ -0,0 +1,111 @@
+name: tests
+
+on:
+  push:
+    branches: main
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  FORCE_COLOR: 1  # Request colored output from CLI tools supporting it
+  PIP_DISABLE_PIP_VERSION_CHECK: 1
+  PY_COLORS: 1  # Recognized by the `py` package, dependency of `pytest`
+  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@v3
+      - uses: actions/setup-python@v4
+        with:
+          cache: "pip"
+          cache-dependency-path: |
+            requirements-dev.txt
+            pyproject.toml
+          python-version: "3.10"
+      - name: Install wheel
+        run: pip install "wheel<1"
+      - name: Install requirements
+        run: |
+          pip install -r requirements-dev.txt
+          pip install -e .[everything]
+      - name: Run mypy on the project
+        run: mypy
+
+  flake8:
+    name: Lint code with flake8
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          cache: "pip"
+          cache-dependency-path: "requirements-dev.txt"
+          python-version: "3.10"
+      - name: Install wheel
+        run: pip install "wheel<1"
+      - name: Install requirements
+        run: pip install -r requirements-dev.txt
+      - name: lint the project
+        run: flake8
+
+  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"]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
+        uses: actions/setup-python@v4
+        with:
+          cache: "pip"
+          cache-dependency-path: |
+            requirements-dev.txt
+            pyproject.toml
+          python-version: ${{ matrix.python-version }}
+      - name: Install wheel
+        run: pip install "wheel<1"
+      - name: Install requirements
+        run: |
+          pip install -r requirements-dev.txt
+          pip install -e .[everything]
+      - name: Run tests under coverage
+        run: |
+          coverage run --branch --include=src/** -m pytest -m "not fails_inexplicably_in_ci"
+          coverage report --show-missing
+      - name: Upload coverage to coveralls
+        # Upload coverage if we are on the main repository and
+        # we're running on Linux (this action only supports Linux)
+        if: github.repository == 'AlexWaygood/typeshed-stats' && matrix.os == 'ubuntu-latest'
+        uses: AndreMiras/coveralls-python-action@develop
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel: true
+          flag-name: py${{ matrix.python-version }}-${{ matrix.os }}
+          debug: true
+
+  coveralls-finish:
+    needs: pytest-tests
+    if: github.repository == 'AlexWaygood/typeshed-stats'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Send finished signal to Coveralls
+        uses: AndreMiras/coveralls-python-action@develop
+        with:
+          parallel-finished: true
+          debug: true

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

@@ -0,0 +1,32 @@
+# 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
+
+env:
+  PIP_DISABLE_PIP_VERSION_CHECK: 1
+
+permissions:
+    contents: read
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python distributions to PyPI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+    - name: Install pypa/build
+      run: pip install build --user
+    - name: Build a binary wheel and a source tarball
+      run: python -m build --sdist --wheel --outdir dist/ .
+    - name: Publish distribution to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

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

@@ -0,0 +1,65 @@
+name: Regenerate examples and docs
+
+on:
+  schedule:
+    - cron: "0 */12 * * *"
+  push:
+    branches:
+      - main
+    paths:
+      - '.github/workflows/regen-examples-and-docs.yml'
+      - 'src/**'
+      - 'scripts/**'
+  workflow_dispatch:
+
+env:
+  PIP_DISABLE_PIP_VERSION_CHECK: 1
+
+jobs:
+  regen_examples_and_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: git config
+        run: |
+          git config --global user.name statsabot
+          git config --global user.email ''
+      - uses: actions/setup-python@v4
+        with:
+          cache: "pip"
+          cache-dependency-path: |
+            requirements-dev.txt
+            pyproject.toml
+          python-version: "3.10"
+      - name: Install wheel
+        run: pip install "wheel<1"
+      - name: Install requirements
+        run: |
+          pip install -r requirements-dev.txt
+          pip install -e .[everything]
+      - name: Regenerate examples and docs
+        run: |
+          python scripts/regenerate_examples_and_docs.py --download-typeshed
+          git commit -a -m "Automated regeneration of examples and docs"
+          git push
+      - name: Deploy docs
+        run: mkdocs gh-deploy --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 != 'workflow_dispatch' && (needs.regen_examples_and_docs.result == 'failure') }}
+    permissions:
+      issues: write
+    steps:
+      - uses: actions/github-script@v6
+        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-22.11.0/.gitignore

@@ -0,0 +1,75 @@
+# 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/

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

@@ -0,0 +1,33 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0 # must match requirements-dev.txt
+    hooks:
+      - id: trailing-whitespace
+      - id: requirements-txt-fixer
+  - repo: https://github.com/hadialqattan/pycln
+    rev: v2.1.2 # must match requirements-dev.txt
+    hooks:
+      - id: pycln
+        args: [--config=pyproject.toml, .]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.2.2
+    hooks:
+      - id: pyupgrade
+        args: [--py310-plus]
+  - repo: https://github.com/psf/black
+    rev: 22.10.0 # must match requirements-dev.txt
+    hooks:
+      - id: black
+        language_version: python3.10
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1  # must match requirements-dev.txt
+    hooks:
+      - id: isort
+        name: isort (python)
+
+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: weekly
+    submodules: false

typeshed_stats-22.11.0/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.

typeshed_stats-22.11.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: typeshed_stats
+Version: 22.11.0
+Summary: Script to gather stats on the status of various typeshed packages
+Project-URL: Homepage, https://github.com/AlexWaygood/typeshed-stats
+Project-URL: Bug Tracker, https://github.com/AlexWaygood/typeshed-stats/issues
+Author-email: Alex Waygood <alex.waygood@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: stubs,typeshed,typing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: aiohttp[speedups]
+Requires-Dist: attrs>=21.3.0
+Requires-Dist: cattrs
+Requires-Dist: packaging
+Requires-Dist: tomli; python_version < '3.11'
+Provides-Extra: everything
+Requires-Dist: markdown; extra == 'everything'
+Requires-Dist: rich; extra == 'everything'
+Provides-Extra: html
+Requires-Dist: markdown; extra == 'html'
+Provides-Extra: rich
+Requires-Dist: rich; extra == 'rich'
+Description-Content-Type: text/markdown
+
+<div align=center>
+
+# typeshed-stats
+
+A CLI tool and library to gather stats on typeshed
+
+[![website](https://img.shields.io/website?down_color=red&down_message=Offline&style=for-the-badge&up_color=green&up_message=Running&url=https%3A%2F%2Falexwaygood.github.io%2Ftypeshed-stats%2F)](https://alexwaygood.github.io/typeshed-stats/)[![build status](https://img.shields.io/github/workflow/status/AlexWaygood/typeshed-stats/tests/main?label=Tests&style=for-the-badge)](https://github.com/AlexWaygood/typeshed-stats/actions/workflows/check.yml)[![Coveralls](https://img.shields.io/coveralls/github/AlexWaygood/typeshed-stats?style=for-the-badge)](https://coveralls.io/github/AlexWaygood/typeshed-stats)
+<br>
+[![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue?style=for-the-badge)](http://mypy-lang.org/)[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black)[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=for-the-badge&labelColor=ef8336)](https://pycqa.github.io/isort/)[![license](https://img.shields.io/github/license/AlexWaygood/typeshed-stats?style=for-the-badge)](https://opensource.org/licenses/MIT)
+
+<hr>
+<br>
+</div>
+
+## What's this project for?
+
+This project is for easy gathering of statistics relating to typeshed's stubs.
+
+Some examples of things you can do from the command line:
+- Create a `.csv` file with stats on all typeshed stubs: `typeshed-stats --typeshed-dir <PATH_TO_TYPESHED_CLONE> --to-file stats.csv` (the `.csv` file extension will be automatically detected by the script to identify the format required).
+- Pretty-print stats on typeshed stubs for emoji and redis to the terminal, in JSON format: `typeshed-stats --typeshed-dir <PATH_TO_TYPESHED_CLONE> --to-json emoji redis`
+- Generate a MarkDown file detailing stats on typeshed's stubs for protobuf and the stdlib: `typeshed-stats --typeshed-dir <PATH_TO_TYPESHED_CLONE> --to-file stats.md stdlib protobuf`
+
+Example usage of the Python-level API:
+```python
+from typeshed_stats.gather import tmpdir_typeshed, gather_stats
+
+with tmpdir_typeshed() as typeshed:
+    stats = gather_stats(typeshed_dir=typeshed)
+```
+
+## How can I use this?
+
+1. Run `pip install git+https://github.com/AlexWaygood/typeshed-stats.git#egg=typeshed-stats[everything]` to install the package
+2. Run `typeshed-stats --help` for information about various options
+
+## Are there any examples of things this script can produce?
+I'm glad you asked! They're in the `examples/` folder in this repo.
+(These examples are generated using the `regenerate_examples.py` script in the repository root.)
+
+## How do I run tests/linters?
+1. Clone the repo and `cd` into it
+2. Create and activate a virtual environment
+3. Run `pip install -r requirements-dev.txt`
+4. Run `pip install -e .[everything]`
+5. Either run the linters/tests individually (see the `.github/workflows` directory for details about what's run in CI) or use the `runtests.py` convenience script to run them all in succession.

typeshed_stats-22.11.0/README.md

@@ -0,0 +1,46 @@
+<div align=center>
+
+# typeshed-stats
+
+A CLI tool and library to gather stats on typeshed
+
+[![website](https://img.shields.io/website?down_color=red&down_message=Offline&style=for-the-badge&up_color=green&up_message=Running&url=https%3A%2F%2Falexwaygood.github.io%2Ftypeshed-stats%2F)](https://alexwaygood.github.io/typeshed-stats/)[![build status](https://img.shields.io/github/workflow/status/AlexWaygood/typeshed-stats/tests/main?label=Tests&style=for-the-badge)](https://github.com/AlexWaygood/typeshed-stats/actions/workflows/check.yml)[![Coveralls](https://img.shields.io/coveralls/github/AlexWaygood/typeshed-stats?style=for-the-badge)](https://coveralls.io/github/AlexWaygood/typeshed-stats)
+<br>
+[![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue?style=for-the-badge)](http://mypy-lang.org/)[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black)[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=for-the-badge&labelColor=ef8336)](https://pycqa.github.io/isort/)[![license](https://img.shields.io/github/license/AlexWaygood/typeshed-stats?style=for-the-badge)](https://opensource.org/licenses/MIT)
+
+<hr>
+<br>
+</div>
+
+## What's this project for?
+
+This project is for easy gathering of statistics relating to typeshed's stubs.
+
+Some examples of things you can do from the command line:
+- Create a `.csv` file with stats on all typeshed stubs: `typeshed-stats --typeshed-dir <PATH_TO_TYPESHED_CLONE> --to-file stats.csv` (the `.csv` file extension will be automatically detected by the script to identify the format required).
+- Pretty-print stats on typeshed stubs for emoji and redis to the terminal, in JSON format: `typeshed-stats --typeshed-dir <PATH_TO_TYPESHED_CLONE> --to-json emoji redis`
+- Generate a MarkDown file detailing stats on typeshed's stubs for protobuf and the stdlib: `typeshed-stats --typeshed-dir <PATH_TO_TYPESHED_CLONE> --to-file stats.md stdlib protobuf`
+
+Example usage of the Python-level API:
+```python
+from typeshed_stats.gather import tmpdir_typeshed, gather_stats
+
+with tmpdir_typeshed() as typeshed:
+    stats = gather_stats(typeshed_dir=typeshed)
+```
+
+## How can I use this?
+
+1. Run `pip install git+https://github.com/AlexWaygood/typeshed-stats.git#egg=typeshed-stats[everything]` to install the package
+2. Run `typeshed-stats --help` for information about various options
+
+## Are there any examples of things this script can produce?
+I'm glad you asked! They're in the `examples/` folder in this repo.
+(These examples are generated using the `regenerate_examples.py` script in the repository root.)
+
+## How do I run tests/linters?
+1. Clone the repo and `cd` into it
+2. Create and activate a virtual environment
+3. Run `pip install -r requirements-dev.txt`
+4. Run `pip install -e .[everything]`
+5. Either run the linters/tests individually (see the `.github/workflows` directory for details about what's run in CI) or use the `runtests.py` convenience script to run them all in succession.