Library and command-line tool to gather stats on typeshed packages
Project description
What's this project for?
This project is for easy gathering of statistics relating to typeshed's stubs. As well as being a CLI tool and library, it also powers a website 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:
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?
- Run
pip install typeshed-stats[rich]
to install the package - Run
typeshed-stats --help
for information about various options
Are there any examples of things this script can produce, other than the website?
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?
- Clone the repo and
cd
into it - Create and activate a virtual environment
- Run
pip install -e .[dev]
- Either run the linters/tests individually (see the
.github/workflows
directory for details about what's run in CI) or use thescripts/runtests.py
convenience script to run them all in succession.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for typeshed_stats-24.11.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ea8780c89b5f20a8c90e279de21bbed2b2ff8bed517b9545d858c4a21709b7c |
|
MD5 | 69146b6c16631ae5721c58fc108c47ce |
|
BLAKE2b-256 | 131542febad8e1d9b74c665659203127dab134c71e24b9d7100b2a6cb6624d24 |