docs/developer_guide/index.md
You need two tools to develop RenderCV:
uv: Package and project manager. It also handles Python installations, so you don't need to install Python separately.just: Command runner. Development commands are defined in the justfile, and you need just to run them.Install them by following their official installation guides:
Clone the repository:
git clone --recursive https://github.com/rendercv/rendercv.git
and change to the repository directory:
cd rendercv
[!NOTE] The
--recursiveflag clones the rendercv-skill submodule. If you forgot it, rungit submodule update --initinside the repo.
Set up the development environment (creates a virtual environment in ./.venv with all dependencies):
just sync
Run just test to verify all tests pass and everything is set up correctly.
Finally, activate the virtual environment in your integrated development environment (IDE). In Visual Studio Code:
Ctrl+Shift+P.Python: Select Interpreter../.venv.That's it! You're now ready to start developing RenderCV.
just sync: Sync all dependencies (including extras and dev groups)just format: Format code with black and ruffjust check: Run all checks (ruff, ty, pre-commit)just lock: Update uv.lock filejust test: Run tests with pytestjust test-coverage: Run tests with coverage reportjust update-testdata: Update test data files (see Testing for more details)just build-docs: Build documentationjust serve-docs: Serve documentation locally with live reloadjust update-schema: Update JSON schemajust update-entry-figures: Update entry figures for documentationjust update-examples: Update example filesjust create-executable: Create standalone executablejust count-lines: Count lines of Python code in the src/ directory