We use pre-commit to run some quick linting such as black.
While pre-commit isn't configured in CI, black is. pylint and running tests are not configured
for pre-commit so commiting is fast.
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 pixeeenvor/usr/bin/env python3 -m venv pixeeenvto specify a specific Python version. If usingbashor any compatible shell, activate withsource pixeeenv/bin/activate. Otherwise, look atvenv's documentation for instructions. -
cd codemodder-pythonandpip 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
pylint,pytest, etc.
You can build the docker image with docker build -t codemodder . and run it with docker run. You can also do
docker run codemodder ...