Developing codemodder-python

Pre-commit install

We use pre-commit to run some quick linting such as black and ruff. This also runs in CI.

Local Development

In general you can rely on Github workflows to see how to run things like linting and tests, but for local development here is a good workflow.

To use virtualenv, create an environment with virtualenv pixeeenv or /usr/bin/env python3 -m venv pixeeenv to specify a specific Python version. If using bash or any compatible shell, activate with source pixeeenv/bin/activate. Otherwise, look at venv's documentation for instructions.
cd codemodder-python and pip install -e . to install the package in development mode
Run pip install ".[all]" to install packages used for development and testing
You should now be able to run ruff, pytest, etc.

Docker

You can build the docker image with docker build -t codemodder . and run it with docker run. You can also do docker run codemodder ...