amaanabbasi / codemodder-python

codemodder-python

This is the Python version of the Codemodder Framework, which builds on traditional codemod frameworks by providing codemods with additional context and services. Codemodder plugins inject codemods with the context and services they need to perform complex transforms.

Pluggability and the complex transforms they enable distinguish codemodder codemods from traditional codemods.

Development Status

The codemodder-python project is still under development. 🚧

The project includes a (growing) set of core codemods. It also supports the development of custom codemods.

Many of the existing codemods make use of Semgrep. The codemodder-python framework will support additional codemod sources in the future.

⚠️ The custom codemod API is under heavy development and is subject to change. The API should not be treated as stable at this time. ⚠️

Installation

To install the package from source, use pip:

pip install .

Running Locally

You can run the codemodder program with

codemodder <directory> --output <file> ...

codemodder --help

Contributing

See CONTRIBUTING.md.