RenderCV

https://docs.rendercv.com
Admin
RenderCV is a command-line tool for rendering professional CVs from YAML input files into multiple...
Tokens:200,166
Snippets:1,686
Trust Score:6.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### entry_point()

Source: https://docs.rendercv.com/api_reference/cli/entry_point

The main entry point for the RenderCV CLI. It checks for a complete installation and raises a helpful error if only the base package is installed, guiding the user to install the full package with the correct command.

```APIDOC
## `entry_point()`

### Description
Entry point for the RenderCV CLI. This function checks if the necessary components for the full CLI functionality are available. If not, it displays a user-friendly error message explaining how to install the complete package.

### Source Code
`src/rendercv/cli/entry_point.py`

### Usage
This function is automatically invoked when the `rendercv` command is executed from the terminal after installation.

### Error Handling
- **ImportError**: If the `rendercv.app` module cannot be imported, indicating an incomplete installation (e.g., `pip install rendercv` instead of `pip install "rendercv[full]"`), a specific error message is printed to `stderr`, and the program exits with status code 1.

### Example of Error Scenario
If a user runs `rendercv` after installing only the base package, they will see an error message guiding them to reinstall with `pip install "rendercv[full]"`.
```

--------------------------------

### Update Example Files

Source: https://docs.rendercv.com/developer_guide

Update the example files used in the project.

```bash
just update-examples

```

--------------------------------

### User Installation Command

Source: https://docs.rendercv.com/developer_guide/project_management

Shows the command for users to install the RenderCV package via pip.

```bash
pip install rendercv

```

--------------------------------

### Install RenderCV with uv

Source: https://docs.rendercv.com/user_guide?q=

Use this command to install RenderCV and its full dependencies using the uv tool.

```bash
uv tool install "rendercv[full]"

```

--------------------------------

### Manually Install Skill for Claude Desktop

Source: https://docs.rendercv.com/user_guide/how_to/use_the_ai_agent_skill

Manually install the RenderCV AI skill for Claude Desktop by downloading the skill zip file and uploading it through the Claude Desktop interface. Follow the steps provided for a successful installation.

```bash
git clone https://github.com/rendercv/rendercv-skill.git
cp -r rendercv-skill/skills/rendercv ~/.claude/skills/

```

--------------------------------

### Install RenderCV Skill using OpenSkills

Source: https://docs.rendercv.com/user_guide/how_to/use_the_ai_agent_skill?q=

Install the RenderCV AI agent skill using the OpenSkills command. This is an alternative method for installing skills.

```bash
npx openskills install rendercv/rendercv-skill
```

--------------------------------

### Manually Install Skill for Claude Desktop

Source: https://docs.rendercv.com/user_guide/how_to/use_the_ai_agent_skill?q=

Manually install the RenderCV skill for Claude Desktop by downloading the skill zip file and uploading it through the Claude Desktop interface.

```bash
git clone https://github.com/rendercv/rendercv-skill.git
cp -r rendercv-skill/skills/rendercv ~/.claude/skills/
```

--------------------------------

### Serve Documentation Locally

Source: https://docs.rendercv.com/developer_guide/documentation

Starts a local server for live preview of documentation changes. The server runs at http://127.0.0.1:8000.

```bash
just serve-docs

```

--------------------------------

### Create a new CV with a specific theme

Source: https://docs.rendercv.com/user_guide/cli_reference?q=

Generates a sample CV file with a specified theme. Useful for getting started with a particular design.

```bash
rendercv new "John Doe" --theme moderncv

```

--------------------------------

### Install RenderCV AI Skill

Source: https://docs.rendercv.com/

Command to install the RenderCV skill for AI coding agents.

```bash
npx skills add rendercv/rendercv-skill

```

--------------------------------

### Developer Environment Setup Command

Source: https://docs.rendercv.com/developer_guide/project_management

Provides the command for developers to synchronize their environment, ensuring consistent Python and dependency versions.

```bash
just sync

```

--------------------------------

### Install RenderCV with pipx

Source: https://docs.rendercv.com/user_guide?q=

Use this command to install RenderCV and its full dependencies in an isolated environment using pipx.

```bash
pipx install "rendercv[full]"

```

--------------------------------

### Entry Data with Custom Fields

Source: https://docs.rendercv.com/user_guide/how_to/arbitrary_keys_in_entries

Example of an entry with standard and custom fields.

```yaml
company: Google
position: Software Engineer
tech_stack: Python, Go, Kubernetes

```

--------------------------------

### Typst Entry Template Example

Source: https://docs.rendercv.com/user_guide/how_to/override_default_templates

An example of a Typst template file for rendering normal entries. It demonstrates Jinja2 loops for iterating over entry data and Typst syntax for layout.

```typst
// Example: entries/NormalEntry.j2.typ
#regular-entry(
  [
{% for line in entry.main_column.splitlines() %}
    {{ line }}
{% endfor %}
  ],
  [
{% for line in entry.date_and_location_column.splitlines() %}
    {{ line }}
{% endfor %}
  ],
)

```

--------------------------------

### Install RenderCV AI Skill using OpenSkills

Source: https://docs.rendercv.com/user_guide/how_to/use_the_ai_agent_skill

Install the RenderCV AI skill using the OpenSkills command. This is an alternative method for integrating the skill with your AI environment.

```bash
npx openskills install rendercv/rendercv-skill

```

--------------------------------

### Example Usage of ProgressPanel

Source: https://docs.rendercv.com/api_reference/cli/render_command/progress_panel

Demonstrates how to use the `ProgressPanel` context manager to update and finish the progress display during CV generation.

```python
with ProgressPanel(quiet=False) as progress:
    progress.update_progress("50", "Generated PDF", [Path("cv.pdf")])
    progress.finish_progress()
# Displays: ✓ 50 ms   Generated PDF: ./cv.pdf
```

--------------------------------

### Install RenderCV Package

Source: https://docs.rendercv.com/

Command to install RenderCV using pip, including optional full features. Requires Python 3.12+.

```bash
pip install "rendercv[full]"

```

--------------------------------

### Install RenderCV Skill for Specific Agent

Source: https://docs.rendercv.com/user_guide/how_to/use_the_ai_agent_skill?q=

Target a specific AI agent when installing the RenderCV skill. Use the -a flag followed by the agent's identifier.

```bash
npx skills add rendercv/rendercv-skill -a claude-code
```

```bash
npx skills add rendercv/rendercv-skill -a cursor
```

```bash
npx skills add rendercv/rendercv-skill -a codex
```

--------------------------------

### Get RenderCV help

Source: https://docs.rendercv.com/user_guide/cli_reference?q=

Displays the help message for the RenderCV CLI, listing all available commands and options. Useful for discovering functionality.

```bash
rendercv --help

```

--------------------------------

### Render Top Note Template Example

Source: https://docs.rendercv.com/api_reference/renderer/templater/footer_and_top_note

An example of using `render_top_note_template` to generate a top note string, typically used for displaying metadata like the last updated date. It substitutes placeholders and formats the date according to the specified locale and template.

```python
result = render_top_note_template(
    "LAST_UPDATED: CURRENT_DATE",
    locale=english_locale,
    current_date=date(2025, 1, 15),
    name="John Doe",
    single_date_template="MONTH_ABBREVIATION YEAR",
)
```

--------------------------------

### Install RenderCV Skill for AI Agents

Source: https://docs.rendercv.com/?q=

Install the RenderCV skill using npx to enable AI coding agents to create and edit your CV. This command works with various AI agents.

```bash
npx skills add rendercv/rendercv-skill
```

--------------------------------

### OneLineEntry Example

Source: https://docs.rendercv.com/user_guide/yaml_input_structure/cv

Use OneLineEntry for concise key-value pairs, such as listing skills. It requires a label and details.

```yaml
label: Programming
details: Python, C++, JavaScript, MATLAB

```

--------------------------------

### Create Sample Settings File

Source: https://docs.rendercv.com/api_reference/schema/sample_generator?q=

Generates a sample YAML file containing only the settings section. This allows users to configure render options independently from CV content.

```python
def create_sample_settings_file(
    *,
    file_path: pathlib.Path | None = None,
    omitted_fields: list[str] | None = None,
) -> str | None:
    """Generate a sample YAML file containing only the settings section.

    Why:
        Standalone settings files let users configure render options
        independently from CV content, design, and locale.

    Args:
        file_path: Optional path to write file.

    Returns:
        YAML string if file_path is None, otherwise None after writing file.
    """
    data_model = create_sample_rendercv_pydantic_model()
    dictionary = rendercv_model_to_dictionary(data_model)
    if omitted_fields is not None:
        for field in omitted_fields:
            dictionary["settings"].pop(field, None)
    return create_sample_yaml_file(
        dictionary={"settings": dictionary["settings"]}, file_path=file_path
    )
```

--------------------------------

### Check RenderCV version

Source: https://docs.rendercv.com/user_guide/cli_reference?q=

Displays the currently installed version of RenderCV. Use this to verify your installation.

```bash
rendercv --version

```

--------------------------------

### Create a Custom Theme

Source: https://docs.rendercv.com/user_guide/how_to/override_default_templates

Initiates the creation of a new, reusable theme. This command sets up the necessary directory structure for a custom theme.

```bash
rendercv create-theme mytheme

```

--------------------------------

### Create Sample Settings File

Source: https://docs.rendercv.com/api_reference/schema/sample_generator

Generates a sample YAML file containing only the settings section. This allows users to configure render options independently from CV content, design, and locale.

```python
def create_sample_settings_file(
    *,
    file_path: pathlib.Path | None = None,
    omitted_fields: list[str] | None = None,
) -> str | None:
    """Generate a sample YAML file containing only the settings section.

    Why:
        Standalone settings files let users configure render options
        independently from CV content, design, and locale.

    Args:
        file_path: Optional path to write file.

    Returns:
        YAML string if file_path is None, otherwise None after writing file.
    """
    data_model = create_sample_rendercv_pydantic_model()
    dictionary = rendercv_model_to_dictionary(data_model)
    if omitted_fields is not None:
        for field in omitted_fields:
            dictionary["settings"].pop(field, None)
    return create_sample_yaml_file(
        dictionary={"settings": dictionary["settings"]}, file_path=file_path
    )

```

--------------------------------

### BulletEntry Field Example

Source: https://docs.rendercv.com/api_reference/schema/models/cv/entries/bullet

Example of how the 'bullet' field can be defined with sample values for text content.

```python
bullet = pydantic.Field(examples=['Python, JavaScript, C++', 'Excellent communication skills'])
```

--------------------------------

### Create Executable

Source: https://docs.rendercv.com/developer_guide

Create a standalone executable version of the project.

```bash
just create-executable

```

--------------------------------

### ExperienceEntry Date Validation

Source: https://docs.rendercv.com/api_reference/schema/models/cv/entries/experience

This validator ensures that dates are consistent. If only a date is provided, start and end dates are ignored. If only an end date is provided, it's treated as a single-day event. If only a start date is provided, the end date is set to 'present'. It also checks that the start date is not after the end date.

```python
import pydantic
import pydantic_core
from typing import Self

from src.rendercv.schema.utils.custom_types import CustomPydanticErrorTypes
from src.rendercv.schema.utils.date_utils import get_current_date, get_date_object


@pydantic.model_validator(mode="after")
def check_and_adjust_dates(self, info: pydantic.ValidationInfo) -> Self:
    date_is_provided = self.date is not None
    start_date_is_provided = self.start_date is not None
    end_date_is_provided = self.end_date is not None

    if date_is_provided:
        # If only date is provided, ignore start_date and end_date:
        self.start_date = None
        self.end_date = None
    elif not start_date_is_provided and end_date_is_provided:
        # If only end_date is provided, assume it is a one-day event and act like
        # only the date is provided:
        self.date = self.end_date
        self.start_date = None
        self.end_date = None
    elif start_date_is_provided and not end_date_is_provided:
        # If only start_date is provided, assume it is an ongoing event, i.e., the
        # end_date is present:
        self.end_date = "present"

    if self.start_date and self.end_date:
        # Check if the start_date is before the end_date:
        current_date = get_current_date(info)
        start_date_object = get_date_object(self.start_date, current_date)
        end_date_object = get_date_object(self.end_date, current_date)
        if start_date_object > end_date_object:
            raise pydantic_core.PydanticCustomError(
                CustomPydanticErrorTypes.other.value,
                "`start_date` cannot be after `end_date`. The `start_date` is"
                " {start_date} and the `end_date` is {end_date}.",
                {
                    "start_date": self.start_date,
                    "end_date": self.end_date,
                },
            )

    return self

```

--------------------------------

### Build Documentation for Deployment

Source: https://docs.rendercv.com/developer_guide/documentation

Generates the final static website files in the 'site/' directory. This command is primarily used by CI/CD pipelines for deployment.

```bash
just build-docs

```

--------------------------------

### Initialize RenderCV CLI App

Source: https://docs.rendercv.com/api_reference/cli/app?q=

Initializes the Typer application with rich markup support and configures help options. This is the main entry point for the CLI.

```python
app = typer.Typer(rich_markup_mode='rich', invoke_without_command=True, context_settings={'help_option_names': ['-h', '--help']})
```

--------------------------------

### Navigate to Repository Directory

Source: https://docs.rendercv.com/developer_guide

Change the current directory to the cloned RenderCV repository.

```bash
cd rendercv

```

--------------------------------

### Basic Python Test Example

Source: https://docs.rendercv.com/developer_guide/testing

This is a simple example of a Python function and its corresponding test function using assert statements. Ensure your tests cover various scenarios.

```python
def sum(a, b):
    return a + b

def test_sum():
    assert sum(2, 3) == 5
    assert sum(-1, 1) == 0
    assert sum(0, 0) == 0
```

--------------------------------

### Create a new custom theme

Source: https://docs.rendercv.com/user_guide/cli_reference?q=

Initializes a new custom theme directory with editable template files. This is the starting point for creating a personalized CV design.

```bash
rendercv create-theme "mytheme"

```

--------------------------------

### Example Usage of handle_user_errors

Source: https://docs.rendercv.com/api_reference/cli/error_handler?q=

This example demonstrates how to apply the @handle_user_errors decorator to a CLI command function. Any RenderCVUserError raised within my_command will be caught and displayed as a user-friendly panel.

```python
@app.command()
@handle_user_errors
def my_command():
    # Any RenderCVUserError gets caught and displayed cleanly
    pass

```

--------------------------------

### Display Welcome Banner with Links

Source: https://docs.rendercv.com/api_reference/cli/new_command/print_welcome

Use this function to display a welcome message including the RenderCV version and a panel of useful links to the app, documentation, source code, and issue tracker. Requires the 'rich' library for enhanced text formatting.

```python
def print_welcome() -> None:
    """Display welcome banner with version and useful links.

    Why:
        New users need guidance on where to find documentation and support.
    """
    print(f"\nWelcome to [dodger_blue3]RenderCV v{__version__}[/dodger_blue3]!\n")
    links = {
        "RenderCV App": "https://rendercv.com",
        "Documentation": "https://docs.rendercv.com",
        "Source code": "https://github.com/rendercv/rendercv/",
        "Bug reports": "https://github.com/rendercv/rendercv/issues/",
    }
    link_strings = [
        f"[bold cyan]{title + ':':<15}[/bold cyan] [link={link}]{link}[/link]"
        for title, link in links.items()
    ]
    link_panel = rich.panel.Panel(
        "\n".join(link_strings),
        title="Useful Links",
        title_align="left",
        border_style="bright_black",
    )

    print(link_panel)
```

--------------------------------

### Install RenderCV AI Skill for Specific Agent

Source: https://docs.rendercv.com/user_guide/how_to/use_the_ai_agent_skill

Install the RenderCV AI skill targeting a specific agent like Claude Code, Cursor, or Codex. This ensures compatibility and proper integration with the chosen AI.

```bash
npx skills add rendercv/rendercv-skill -a claude-code

```

```bash
npx skills add rendercv/rendercv-skill -a cursor

```

```bash
npx skills add rendercv/rendercv-skill -a codex

```

--------------------------------

### Validate Education Dates

Source: https://docs.rendercv.com/api_reference/schema/models/cv/entries/education

This validator ensures that the provided dates for an education entry are consistent. It handles cases where only a single date is provided, or when start and end dates are given, ensuring the start date does not precede the end date.

```python
import pydantic
from typing import Self

# Assuming CustomPydanticErrorTypes, get_current_date, and get_date_object are defined elsewhere
# from .bases.entry_with_complex_fields import CustomPydanticErrorTypes
# from .bases.entry_with_complex_fields import get_current_date, get_date_object

class EducationEntry(pydantic.BaseModel):
    # ... other fields like area, date, degree, etc. ...
    date: str | None = None
    start_date: str | None = None
    end_date: str | None = None

    @pydantic.model_validator(mode="after")
    def check_and_adjust_dates(self, info: pydantic.ValidationInfo) -> Self:
        date_is_provided = self.date is not None
        start_date_is_provided = self.start_date is not None
        end_date_is_provided = self.end_date is not None

        if date_is_provided:
            # If only date is provided, ignore start_date and end_date:
            self.start_date = None
            self.end_date = None
        elif not start_date_is_provided and end_date_is_provided:
            # If only end_date is provided, assume it is a one-day event and act like
            # only the date is provided:
            self.date = self.end_date
            self.start_date = None
            self.end_date = None
        elif start_date_is_provided and not end_date_is_provided:
            # If only start_date is provided, assume it is an ongoing event, i.e., the
            # end_date is present:
            self.end_date = "present"

        if self.start_date and self.end_date:
            # Check if the start_date is before the end_date:
            current_date = get_current_date(info) # Placeholder for actual function
            start_date_object = get_date_object(self.start_date, current_date) # Placeholder for actual function
            end_date_object = get_date_object(self.end_date, current_date) # Placeholder for actual function
            if start_date_object > end_date_object:
                raise pydantic.ValidationError(
                    "`start_date` cannot be after `end_date`. The `start_date` is {self.start_date} and the `end_date` is {self.end_date}.",
                    params={"start_date": self.start_date, "end_date": self.end_date},
                )

        return self

```

--------------------------------

### Create Sample Design File

Source: https://docs.rendercv.com/api_reference/schema/sample_generator

Generates a sample YAML file containing only the design section. Use this to explore theme options without CV content. Accepts an optional file path to write the output.

```python
def create_sample_design_file(
    *,
    file_path: pathlib.Path | None = None,
    theme: str = "classic",
) -> str | None:
    """Generate a sample YAML file containing only the design section.

    Why:
        Standalone design files let users explore all theme options
        without mixing in CV content or locale settings.

    Args:
        file_path: Optional path to write file.
        theme: Design theme identifier.

    Returns:
        YAML string if file_path is None, otherwise None after writing file.
    """
    if theme not in available_themes:
        message = (
            f"The theme {theme} is not available. The available themes are:"
            f" {available_themes}"
        )
        raise RenderCVUserError(message)

    data_model = create_sample_rendercv_pydantic_model(theme=theme)
    dictionary = rendercv_model_to_dictionary(data_model)
    return create_sample_yaml_file(
        dictionary={"design": dictionary["design"]}, file_path=file_path
    )

```

--------------------------------

### create_sample_settings_file

Source: https://docs.rendercv.com/api_reference/schema/sample_generator

Generates a sample YAML file containing only the settings section. This allows users to configure render options independently from CV content, design, and locale.

```APIDOC
## create_sample_settings_file

### Description
Generate a sample YAML file containing only the settings section. Standalone settings files let users configure render options independently from CV content, design, and locale.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method
```python
def create_sample_settings_file(*, file_path=None, omitted_fields=None)
```

### Parameters
* **`file_path`** (`Path | None`, default: `None`) – Optional path to write file.
* **`omitted_fields`** (`list[str] | None`, default: `None`) – 

### Returns
* `str | None` – YAML string if file_path is None, otherwise None after writing file.
```

--------------------------------

### NormalEntry Date Validation

Source: https://docs.rendercv.com/api_reference/schema/models/cv/entries/normal

This validator ensures that dates are logically consistent. It handles cases where only a single date is provided, or when a start date implies an ongoing event. It also checks that the start date does not occur after the end date.

```python
@pydantic.model_validator(mode="after")
def check_and_adjust_dates(self, info: pydantic.ValidationInfo) -> Self:
    date_is_provided = self.date is not None
    start_date_is_provided = self.start_date is not None
    end_date_is_provided = self.end_date is not None

    if date_is_provided:
        # If only date is provided, ignore start_date and end_date:
        self.start_date = None
        self.end_date = None
    elif not start_date_is_provided and end_date_is_provided:
        # If only end_date is provided, assume it is a one-day event and act like
        # only the date is provided:
        self.date = self.end_date
        self.start_date = None
        self.end_date = None
    elif start_date_is_provided and not end_date_is_provided:
        # If only start_date is provided, assume it is an ongoing event, i.e., the
        # end_date is present:
        self.end_date = "present"

    if self.start_date and self.end_date:
        # Check if the start_date is before the end_date:
        current_date = get_current_date(info)
        start_date_object = get_date_object(self.start_date, current_date)
        end_date_object = get_date_object(self.end_date, current_date)
        if start_date_object > end_date_object:
            raise pydantic_core.PydanticCustomError(
                CustomPydanticErrorTypes.other.value,
                "`start_date` cannot be after `end_date`. The `start_date` is" " {start_date} and the `end_date` is {end_date}.",
                {
                    "start_date": self.start_date,
                    "end_date": self.end_date,
                },
            )

    return self
```

--------------------------------

### EducationEntry Date Validation

Source: https://docs.rendercv.com/api_reference/schema/models/cv/entries/education?q=

This validator ensures that dates are consistent and handles different date formats. It adjusts start and end dates based on provided information and checks that the start date does not precede the end date. Use this validator to maintain data integrity for educational entries.

```python
import pydantic
import pydantic_core
from typing import Self

from src.rendercv.schema.utils import CustomPydanticErrorTypes, get_current_date, get_date_object


@pydantic.model_validator(mode="after")
def check_and_adjust_dates(self, info: pydantic.ValidationInfo) -> Self:
    date_is_provided = self.date is not None
    start_date_is_provided = self.start_date is not None
    end_date_is_provided = self.end_date is not None

    if date_is_provided:
        # If only date is provided, ignore start_date and end_date:
        self.start_date = None
        self.end_date = None
    elif not start_date_is_provided and end_date_is_provided:
        # If only end_date is provided, assume it is a one-day event and act like
        # only the date is provided:
        self.date = self.end_date
        self.start_date = None
        self.end_date = None
    elif start_date_is_provided and not end_date_is_provided:
        # If only start_date is provided, assume it is an ongoing event, i.e., the
        # end_date is present:
        self.end_date = "present"

    if self.start_date and self.end_date:
        # Check if the start_date is before the end_date:
        current_date = get_current_date(info)
        start_date_object = get_date_object(self.start_date, current_date)
        end_date_object = get_date_object(self.end_date, current_date)
        if start_date_object > end_date_object:
            raise pydantic_core.PydanticCustomError(
                CustomPydanticErrorTypes.other.value,
                "`start_date` cannot be after `end_date`. The `start_date` is"
                " {start_date} and the `end_date` is {end_date}.",
                {
                    "start_date": self.start_date,
                    "end_date": self.end_date,
                },
            )

    return self

```

--------------------------------

### Run All Tests

Source: https://docs.rendercv.com/developer_guide/how_to/add_social_network?q=

Execute the `test` command to ensure all tests pass after integrating the new social network.

```bash
just test

```

--------------------------------

### ExperienceEntry Date Validation

Source: https://docs.rendercv.com/api_reference/schema/models/cv/entries/experience?q=

This validator ensures that date fields within the ExperienceEntry model are consistent. It handles cases where only a single date is provided, or when a start date is given without an end date (implying an ongoing event). It also checks that the start date does not occur after the end date.

```python
import pydantic
import pydantic_core
from typing import Self

from src.rendercv.schema.models.cv.custom_types import CustomPydanticErrorTypes
from src.rendercv.schema.utils.datetime_utils import get_current_date, get_date_object


@pydantic.model_validator(mode="after")
def check_and_adjust_dates(self, info: pydantic.ValidationInfo) -> Self:
    date_is_provided = self.date is not None
    start_date_is_provided = self.start_date is not None
    end_date_is_provided = self.end_date is not None

    if date_is_provided:
        # If only date is provided, ignore start_date and end_date:
        self.start_date = None
        self.end_date = None
    elif not start_date_is_provided and end_date_is_provided:
        # If only end_date is provided, assume it is a one-day event and act like
        # only the date is provided:
        self.date = self.end_date
        self.start_date = None
        self.end_date = None
    elif start_date_is_provided and not end_date_is_provided:
        # If only start_date is provided, assume it is an ongoing event, i.e., the
        # end_date is present:
        self.end_date = "present"

    if self.start_date and self.end_date:
        # Check if the start_date is before the end_date:
        current_date = get_current_date(info)
        start_date_object = get_date_object(self.start_date, current_date)
        end_date_object = get_date_object(self.end_date, current_date)
        if start_date_object > end_date_object:
            raise pydantic_core.PydanticCustomError(
                CustomPydanticErrorTypes.other.value,
                "`start_date` cannot be after `end_date`. The `start_date` is"
                " {start_date} and the `end_date` is {end_date}.",
                {
                    "start_date": self.start_date,
                    "end_date": self.end_date,
                },
            )

    return self

```

--------------------------------

### create_init_file_for_theme

Source: https://docs.rendercv.com/api_reference/cli/create_theme_command/create_init_file_for_theme

Generates the __init__.py file for a custom theme. This is useful for creating new themes based on the existing ClassicTheme structure, providing a starting point with predefined Pydantic models for design options.

```APIDOC
## `create_init_file_for_theme(theme_name, init_file_path)`

### Description
Generate `__init__.py` for custom theme by templating from ClassicTheme. Custom themes need Pydantic models defining design options. Generating from ClassicTheme provides a working example with all standard fields users can modify or extend.

### Parameters
#### Path Parameters
- **`theme_name`** (str) - Required - Snake_case theme identifier.
- **`init_file_path`** (Path) - Required - Destination path for **init**.py.
```

--------------------------------

### Setup Local Typst Package Resolution

Source: https://docs.rendercv.com/api_reference/renderer/pdf_png?q=

Sets up a temporary directory for local Typst package resolution, ensuring bundled packages like 'rendercv' and 'fontawesome' are available for the Typst compiler. This avoids the need to download packages from Typst Universe.

```python
@functools.lru_cache(maxsize=1)
def get_package_path() -> pathlib.Path:
    """Set up local Typst package resolution from bundled Typst packages.

    Why:
        Bundled Typst packages (rendercv, fontawesome) are shipped inside the
        Python package so that PDF compilation works without downloading from
        Typst Universe. The Typst compiler expects packages in a directory
        structure of preview/{name}/{version}/, so this creates a temporary
        directory with that layout.

    Returns:
        Path to temporary package cache directory.
    """
    temp_dir = pathlib.Path(tempfile.mkdtemp(prefix="rendercv-pkg-"))
    atexit.register(shutil.rmtree, str(temp_dir), True)

    renderer_dir = pathlib.Path(__file__).parent

    install_bundled_typst_package(
        bundled_path=renderer_dir / "rendercv_typst",
        package_name="rendercv",
        temp_dir=temp_dir,
        typ_files=["lib.typ"],
    )

    install_bundled_typst_package(
        bundled_path=renderer_dir / "typst_fontawesome",
        package_name="fontawesome",
        temp_dir=temp_dir,
        typ_files=[
            "lib.typ",
            "lib-impl.typ",
            "lib-gen-func.typ",
            "lib-gen-map.typ",
        ],
    )

    return temp_dir

```

--------------------------------

### Validate and Adjust Dates in CV Entries

Source: https://docs.rendercv.com/api_reference/schema/models/cv/entries/bases/entry_with_complex_fields?q=

This validator ensures date consistency within CV entries. It handles cases where only a single date is provided, or when only a start or end date is given, adjusting them to represent one-day events or ongoing events. It also checks that the start date precedes the end date.

```python
import pydantic
import pydantic_core
from typing import Self

# Assuming get_current_date and get_date_object are defined elsewhere
# Assuming CustomPydanticErrorTypes is defined elsewhere

@pydantic.model_validator(mode="after")
def check_and_adjust_dates(self, info: pydantic.ValidationInfo) -> Self:
    date_is_provided = self.date is not None
    start_date_is_provided = self.start_date is not None
    end_date_is_provided = self.end_date is not None

    if date_is_provided:
        # If only date is provided, ignore start_date and end_date:
        self.start_date = None
        self.end_date = None
    elif not start_date_is_provided and end_date_is_provided:
        # If only end_date is provided, assume it is a one-day event and act like
        # only the date is provided:
        self.date = self.end_date
        self.start_date = None
        self.end_date = None
    elif start_date_is_provided and not end_date_is_provided:
        # If only start_date is provided, assume it is an ongoing event, i.e., the
        # end_date is present:
        self.end_date = "present"

    if self.start_date and self.end_date:
        # Check if the start_date is before the end_date:
        current_date = get_current_date(info)
        start_date_object = get_date_object(self.start_date, current_date)
        end_date_object = get_date_object(self.end_date, current_date)
        if start_date_object > end_date_object:
            raise pydantic_core.PydanticCustomError(
                CustomPydanticErrorTypes.other.value,
                "`start_date` cannot be after `end_date`. The `start_date` is"
                " {start_date} and the `end_date` is {end_date}.",
                {
                    "start_date": self.start_date,
                    "end_date": self.end_date,
                },
            )

    return self

```

--------------------------------

### Create Theme YAML File

Source: https://docs.rendercv.com/developer_guide/how_to/add_theme

Create a new YAML file for your custom theme in the specified directory.

```bash
touch src/rendercv/schema/models/design/other_themes/mytheme.yaml

```

--------------------------------

### BulletEntry Example

Source: https://docs.rendercv.com/user_guide/yaml_input_structure/cv

Use BulletEntry for a single, distinct bullet point. It requires only the 'bullet' text.

```yaml
bullet: This is a bullet entry.

```

--------------------------------

### CLI Entry Point Function

Source: https://docs.rendercv.com/api_reference/cli/entry_point?q=

This function serves as the main entry point for the RenderCV CLI. It checks if RenderCV was installed with the full set of dependencies. If not, it displays an informative error message and exits.

```python
def entry_point() -> None:
    """Entry point for the RenderCV CLI."""
    try:
        from .app import app as cli_app  # NOQA: PLC0415
    except ImportError:
        error_message = """
It looks like you installed RenderCV with:

    pip install rendercv

But RenderCV needs to be installed with:

    pip install "rendercv[full]"

Please reinstall with the correct command above.
"""
        sys.stderr.write(error_message)
        raise SystemExit(1) from None

    cli_app()
```
Tokens:
Raw