https://github.com/gousaiyang/python-change-parser
This tool parses Python documentation and searches for new features and changed features of Python.
https://github.com/gousaiyang/python-change-parser
changes documentation features python
Last synced: about 1 month ago
JSON representation
This tool parses Python documentation and searches for new features and changed features of Python.
- Host: GitHub
- URL: https://github.com/gousaiyang/python-change-parser
- Owner: gousaiyang
- License: mit
- Created: 2020-01-01T00:12:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-18T01:17:33.000Z (over 3 years ago)
- Last Synced: 2025-02-15T06:41:30.377Z (3 months ago)
- Topics: changes, documentation, features, python
- Language: HTML
- Size: 465 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python-change-parser
This tool parses Python documentation and searches for new features and changed features of Python. It can generate HTML reports, and you can also extract JSON data for further analysis. The result can be used to generate rules for the [`vermin`](https://github.com/netromdk/vermin) project.
You can find the already generated reports under the [`output`](https://github.com/gousaiyang/python-change-parser/tree/master/output) directory.
If you want to run the code by yourself, please download the HTML version of Python documentation from [here](https://docs.python.org/3/download.html) and extract it into the `data` directory.
Known drawbacks and issues:
- Some changes may be undocumented (especially the major differences between Python 2 and Python 3).
- Some changes are expressed vaguely in the documentation. Different kinds of wording should be identified. String matching is error prone, so manual inspection of the result is needed.
- A single `versionmodified` indicator may be associated with multiple objects (e.g. [`operator.matmul` and `operator.__matmul__` are both new in 3.5](https://docs.python.org/3/library/operator.html#operator.matmul)). Such entries are now marked as `multi` and highlighted in HTML output.