DevEnvironment

This page describes tips on the development environment for LensKit.

Setting Up

Follow the instructions in DevWorkflow to get the source code and set up the Conda environment.

Editor and Configuration

Any decent Python editor should be fine. Visual Studio Code is known to work particularly well; we recommend installing the EditorConfig and Python extensions.

We include a .editorconfig file in the repository to help auto-configure any editor that supports editorconfig.

We lint and format with ruff and type-check with Pyright, and include configuration files for them.

Make sure you have pre-commit installed and run pre-commit install on the repository to check code before submitting.