8000 gh-102110: Updated cpython/Tools/README by TylerBurgee · Pull Request #103111 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-102110: Updated cpython/Tools/README #103111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

gh-102110: Updated cpython/Tools/README #103111

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
afa0425
Update cpython/Tools/README
TylerBurgee Mar 29, 2023
765868a
📜🤖 Added by blurb_it.
blurb-it[bot] Mar 29, 2023
b21b51c
Update README
TylerBurgee Mar 30, 2023
6d0b153
Update README
TylerBurgee Mar 30, 2023
761cf56
Update 2023-03-29-14-09-19.gh-issue-102110.TrxywJ.rst
TylerBurgee Mar 30, 2023
e74b533
Merge branch 'main' into patch-1
TylerBurgee Mar 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update cpython/Tools/README 
Added all cpython/Tools modules to the README and included descriptions for the following modules:
- c-analyzer
- cases_generator
- importbench
- nuget
- wasm

*Question: Should we remove the parser module from README? I do not see it listed in cpython/Tools anymore.
  • Loading branch information
@TylerBurgee
TylerBurgee authored Mar 29, 2023
commit afa042512da2de2e9062c5ddc8209888c3887922
26 changes: 26 additions & 0 deletions Tools/README
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
This directory contains a number of Python programs that are useful
while building or extending Python.

build ...

buildbot Batchfiles for running on Windows buildbot workers.

c-analyzer Converter functions for primitive type casting and creating
new docstrings.

cases_generator Parses instruction definitions from Python/bytecodes.c,
writes each generated case to Python/generated_cases.c.h.

ccbench A Python threads-based concurrency benchmark. (*)

clinic ...

freeze Create a stand-alone executable from a Python program.

gdb Python code to be run inside gdb, to make it easier to
Expand All @@ -14,11 +24,20 @@ i18n Tools for internationalization. pygettext.py
parses Python source code and generates .pot files,
and msgfmt.py generates a binary message catalog
from a catalog in text format.

importbench A set of micro-benchmarks for various import scenarios.
Can be used to to measure impact of possible code changes.

iobench Benchmark for the new Python I/O system. (*)

msi Support for packaging Python as an MSI package on Windows.

nuget Runs Python tests against multiple installations of OpenSSL
and LibreSSL. Contains tools to download the
OpenSSL/LibreSSL tar bundle.

patchcheck ...

parser Un-parsing tool to generate code from an AST.

peg_generator PEG-based parser generator (pegen) used for new parser.
Expand All @@ -27,16 +46,23 @@ scripts A number of useful single-file programs, e.g. tabnanny.py
by Tim Peters, which checks for inconsistent mixing of
tabs and spaces, and 2to3, which converts Python 2 code
to Python 3 code.

ssl ...

stringbench A suite of micro-benchmarks for various operations on
strings (both 8-bit and unicode). (*)

tz ...

unicode Tools for generating unicodedata and codecs from unicode.org
and other mapping files (by Fredrik Lundh, Marc-Andre Lemburg
and Martin von Loewis).

unittestgui A Tkinter based GUI test runner for unittest, with test
discovery.

wasm Tools for facilitating cross-compilation of CPython to
WebAssmebly (WASM).


(*) A generic benchmark suite is maintained separately at https://github.com/python/performance
Expand Down
0