rendercv/docs/developer_guide/index.md

toc_depth

toc_depth
1

Setup

Prerequisites

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:

• Install uv
• Install just

Setting Up the Development Environment

1. Clone the repository:

   git clone https://github.com/rendercv/rendercv.git
   

   and change to the repository directory:

   cd rendercv
   

2. Set up the development environment (creates a virtual environment in ./.venv with all dependencies):

   just sync
   

3. Run just test to verify all tests pass and everything is set up correctly.

4. Finally, activate the virtual environment in your integrated development environment (IDE). In Visual Studio Code:

   • Press Ctrl+Shift+P.
   • Type Python: Select Interpreter.
   • Select the one in ./.venv.

That's it! You're now ready to start developing RenderCV.

Available Commands

Development

• just sync: Sync all dependencies (including extras and dev groups)
• just format: Format code with black and ruff
• just check: Run all checks (ruff, pyright, pre-commit)
• just lock: Update uv.lock file

Testing

• just test: Run tests with pytest
• just test-coverage: Run tests with coverage report
• just update-testdata: Update test data files (see Testing for more details)

Documentation

• just build-docs: Build documentation
• just serve-docs: Serve documentation locally with live reload

Scripts

• just update-schema: Update JSON schema
• just update-entry-figures: Update entry figures for documentation
• just update-examples: Update example files
• just create-executable: Create standalone executable

Utilities

• just count-lines: Count lines of Python code in the src/ directory