Coverage for rendercv/data/__init__.py: 100%
4 statements
« prev ^ index » next coverage.py v7.6.10, created at 2025-01-26 00:25 +0000
« prev ^ index » next coverage.py v7.6.10, created at 2025-01-26 00:25 +0000
1"""
2The `rendercv.data` package contains the necessary classes and functions for
4- Parsing and validating a YAML input file
5- Computing some properties based on a YAML input file (like converting ISO dates to
6 plain English, URLs of social networks, etc.)
7- Generating a JSON Schema for RenderCV's data format
8- Generating a sample YAML input file
10The validators and data format of RenderCV are written using
11[Pydantic](https://github.com/pydantic/pydantic).
12"""
14from .generator import (
15 create_a_sample_data_model,
16 create_a_sample_yaml_input_file,
17 generate_json_schema,
18 generate_json_schema_file,
19)
20from .models import (
21 BulletEntry,
22 CurriculumVitae,
23 EducationEntry,
24 Entry,
25 ExperienceEntry,
26 Locale,
27 NormalEntry,
28 OneLineEntry,
29 PublicationEntry,
30 RenderCommandSettings,
31 RenderCVDataModel,
32 RenderCVSettings,
33 SectionContents,
34 SocialNetwork,
35 available_entry_models,
36 available_entry_type_names,
37 available_social_networks,
38 available_theme_options,
39 available_themes,
40 format_date,
41 get_date_input,
42 make_a_url_clean,
43 make_keywords_bold_in_a_string,
44 rendercv_data_model_fields,
45)
46from .reader import (
47 get_error_message_and_location_and_value_from_a_custom_error,
48 parse_validation_errors,
49 read_a_yaml_file,
50 read_input_file,
51 validate_input_dictionary_and_return_the_data_model,
52)
54__all__ = [
55 "BulletEntry",
56 "CurriculumVitae",
57 "EducationEntry",
58 "Entry",
59 "ExperienceEntry",
60 "Locale",
61 "NormalEntry",
62 "OneLineEntry",
63 "PublicationEntry",
64 "RenderCVDataModel",
65 "RenderCVSettings",
66 "RenderCommandSettings",
67 "SectionContents",
68 "SocialNetwork",
69 "available_entry_models",
70 "available_entry_type_names",
71 "available_social_networks",
72 "available_theme_options",
73 "available_themes",
74 "create_a_sample_data_model",
75 "create_a_sample_yaml_input_file",
76 "format_date",
77 "generate_json_schema",
78 "generate_json_schema_file",
79 "get_date_input",
80 "get_error_message_and_location_and_value_from_a_custom_error",
81 "make_a_url_clean",
82 "make_keywords_bold_in_a_string",
83 "parse_validation_errors",
84 "read_a_yaml_file",
85 "read_input_file",
86 "rendercv_data_model_fields",
87 "validate_input_dictionary_and_return_the_data_model",
88]