typeshed-stats


Nametypeshed-stats JSON
Version 22.12.0 PyPI version JSON
download
home_page
SummaryScript to gather stats on the status of various typeshed packages
upload_time2022-12-19 15:19:58
maintainer
docs_urlNone
author
requires_python>=3.10
licenseMIT
keywords stubs typeshed typing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <div align=center>

# typeshed-stats

<img src="https://user-images.githubusercontent.com/66076021/202873196-3af493e6-bca0-4c1a-8853-73635b5c1ca8.png" width="500">

<br><hr>

## A CLI tool and library to gather stats on [typeshed](https://github.com/python/typeshed)

<br>

[![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/actions/workflow/status/AlexWaygood/typeshed-stats/test.yml?branch=main&label=Tests&style=for-the-badge)](https://github.com/AlexWaygood/typeshed-stats/actions/workflows/test.yml)[![Coveralls](https://img.shields.io/coverallsCoverage/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)
<br>[![PyPI](https://img.shields.io/pypi/v/typeshed-stats?style=for-the-badge)](https://pypi.org/project/typeshed-stats/)![PyPI - Python Version](https://img.shields.io/pypi/pyversions/typeshed-stats?style=for-the-badge)![PyPI - Wheel](https://img.shields.io/pypi/wheel/typeshed-stats?style=for-the-badge)

<hr>
<br>
</div>

## What's this project for?

This project is for easy gathering of statistics relating to [typeshed](https://github.com/python/typeshed)'s stubs. As well as being a CLI tool and library, it also powers [a website](https://alexwaygood.github.io/typeshed-stats/) where stats about typeshed's stubs are uploaded twice a day.

This project was created by Alex Waygood. It is not necessarily endorsed by any of the other typeshed maintainers.

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_on_all_packages = gather_stats_on_multiple_packages(typeshed_dir=typeshed)
```

## How can I use this?

1. Run `pip install typeshed-stats[rich]` to install the package
1. Run `typeshed-stats --help` for information about various options

## Are there any examples of things this script can produce, other than [the website](https://alexwaygood.github.io/typeshed-stats/)?

I'm glad you asked! They're in the `examples/` folder in this repo.
(These examples are generated using the `regenerate.py` script in the `scripts/` directory.)

## How do I run tests/linters?

1. Clone the repo and `cd` into it
1. Create and activate a virtual environment
1. Run `pip install -r requirements/all.txt`
1. Run `pip install -e .[rich]`
1. Either run the linters/tests individually (see the `.github/workflows` directory for details about what's run in CI) or use the `scripts/runtests.py` convenience script to run them all in succession.

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "typeshed-stats",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "stubs,typeshed,typing",
    "author": "",
    "author_email": "Alex Waygood <alex.waygood@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/d8/c7/dd156eecfe4821f7be090a135c7f55379d029abe91ef812c3de7e144352a/typeshed_stats-22.12.0.tar.gz",
    "platform": null,
    "description": "<div align=center>\n\n# typeshed-stats\n\n<img src=\"https://user-images.githubusercontent.com/66076021/202873196-3af493e6-bca0-4c1a-8853-73635b5c1ca8.png\" width=\"500\">\n\n<br><hr>\n\n## A CLI tool and library to gather stats on [typeshed](https://github.com/python/typeshed)\n\n<br>\n\n[![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/actions/workflow/status/AlexWaygood/typeshed-stats/test.yml?branch=main&label=Tests&style=for-the-badge)](https://github.com/AlexWaygood/typeshed-stats/actions/workflows/test.yml)[![Coveralls](https://img.shields.io/coverallsCoverage/github/AlexWaygood/typeshed-stats?style=for-the-badge)](https://coveralls.io/github/AlexWaygood/typeshed-stats)\n<br>\n[![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)\n<br>[![PyPI](https://img.shields.io/pypi/v/typeshed-stats?style=for-the-badge)](https://pypi.org/project/typeshed-stats/)![PyPI - Python Version](https://img.shields.io/pypi/pyversions/typeshed-stats?style=for-the-badge)![PyPI - Wheel](https://img.shields.io/pypi/wheel/typeshed-stats?style=for-the-badge)\n\n<hr>\n<br>\n</div>\n\n## What's this project for?\n\nThis project is for easy gathering of statistics relating to [typeshed](https://github.com/python/typeshed)'s stubs. As well as being a CLI tool and library, it also powers [a website](https://alexwaygood.github.io/typeshed-stats/) where stats about typeshed's stubs are uploaded twice a day.\n\nThis project was created by Alex Waygood. It is not necessarily endorsed by any of the other typeshed maintainers.\n\nSome examples of things you can do from the command line:\n\n- 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).\n- 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`\n- 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`\n\nExample usage of the Python-level API:\n\n```python\nfrom typeshed_stats.gather import tmpdir_typeshed, gather_stats\n\nwith tmpdir_typeshed() as typeshed:\n    stats_on_all_packages = gather_stats_on_multiple_packages(typeshed_dir=typeshed)\n```\n\n## How can I use this?\n\n1. Run `pip install typeshed-stats[rich]` to install the package\n1. Run `typeshed-stats --help` for information about various options\n\n## Are there any examples of things this script can produce, other than [the website](https://alexwaygood.github.io/typeshed-stats/)?\n\nI'm glad you asked! They're in the `examples/` folder in this repo.\n(These examples are generated using the `regenerate.py` script in the `scripts/` directory.)\n\n## How do I run tests/linters?\n\n1. Clone the repo and `cd` into it\n1. Create and activate a virtual environment\n1. Run `pip install -r requirements/all.txt`\n1. Run `pip install -e .[rich]`\n1. Either run the linters/tests individually (see the `.github/workflows` directory for details about what's run in CI) or use the `scripts/runtests.py` convenience script to run them all in succession.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Script to gather stats on the status of various typeshed packages",
    "version": "22.12.0",
    "split_keywords": [
        "stubs",
        "typeshed",
        "typing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "9def82f58938e09994491ba9e1a091a9",
                "sha256": "2741854fc796398d6fee95ddafd477bc05428670576c20cb365a8ddb4ddcfc06"
            },
            "downloads": -1,
            "filename": "typeshed_stats-22.12.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9def82f58938e09994491ba9e1a091a9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 18987,
            "upload_time": "2022-12-19T15:19:56",
            "upload_time_iso_8601": "2022-12-19T15:19:56.387023Z",
            "url": "https://files.pythonhosted.org/packages/29/bf/e3fce732fec7a926888839ff1303e169b934b2753b1cbce827e5a864072c/typeshed_stats-22.12.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "5e40eb9d99804a439371d953aab44d01",
                "sha256": "9de348b393b9b6b6290ef0d6129f2b3465b46ebaafd7b39cea193118d2e4956a"
            },
            "downloads": -1,
            "filename": "typeshed_stats-22.12.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5e40eb9d99804a439371d953aab44d01",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 1981754,
            "upload_time": "2022-12-19T15:19:58",
            "upload_time_iso_8601": "2022-12-19T15:19:58.201977Z",
            "url": "https://files.pythonhosted.org/packages/d8/c7/dd156eecfe4821f7be090a135c7f55379d029abe91ef812c3de7e144352a/typeshed_stats-22.12.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-19 15:19:58",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "typeshed-stats"
}
Elapsed time: 0.01951s