CLI reference
To install the CLI, simply run pip install typeshed-stats[rich]
.
[33mUsage:[0m [37mtypeshed-stats[0m [[97m-h[0m] [[97m--log[0m [33m{NOTSET,DEBUG,INFO,WARNING,ERROR,CRITICAL}[0m]
[[97m--pprint[0m | [97m--to-json[0m | [97m--to-csv[0m | [97m--to-markdown[0m |
[97m-f[0m [33mWRITEFILE[0m | [97m--upstream-repo[0m] [[97m-o[0m] ([97m-t[0m [33mTYPESHED_DIR[0m |
[97m-d[0m)
[[97mpackages[0m [97m...[0m]
[39mTool to gather stats on typeshed[0m
[33mPositional Arguments:[0m
[97mpackages[0m [39mPackages to gather stats on (defaults to all[0m
[39mthird-party packages, plus the stdlib)[0m
[33mOptions:[0m
[97m-h[0m, [97m--help[0m [39mshow this help message and exit[0m
[97m--log[0m [33m{NOTSET,DEBUG,INFO,WARNING,ERROR,CRITICAL}[0m
[39mSpecify the level of logging (defaults to[0m
[39mlogging.INFO)[0m
[33mOutput Options:[0m
[97m--pprint[0m [39mPretty-print Python representations of the data[0m
[39m(default output)[0m
[97m--to-json[0m [39mPrint output as JSON to the terminal[0m
[97m--to-csv[0m [39mPrint output in csv format to the terminal[0m
[97m--to-markdown[0m [39mPrint output as formatted MarkDown to the terminal[0m
[97m-f[0m, [97m--to-file[0m [33mWRITEFILE[0m
[39mWrite output to WRITEFILE instead of printing to the[0m
[39mterminal. The file format will be inferred by the file[0m
[39mextension. The file extension must be one of ['.csv',[0m
[39m'.json', '.md', '.txt'].[0m
[97m--upstream-repo[0m [39mDon't output anything to the terminal; open the URL of[0m
[39mthe upstream repo in a web browser instead[0m
[97m-o[0m, [97m--overwrite[0m [39mOverwrite the path passed to `[0m[1;39m--file[0m[39m` if it already[0m
[39mexists (defaults to False)[0m
[33mTypeshed Options:[0m
[97m-t[0m, [97m--typeshed-dir[0m [33mTYPESHED_DIR[0m
[39mPath to a local clone of typeshed, to be used as the[0m
[39mbasis for analysis[0m
[97m-d[0m, [97m--download-typeshed[0m
[39mDownload a fresh copy of typeshed into a temporary[0m
[39mdirectory, and use that as the basis for analysis[0m