cv-renderer 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- cv_renderer-0.1.0/.env.example +10 -0
- cv_renderer-0.1.0/.github/workflows/ci.yml +39 -0
- cv_renderer-0.1.0/.github/workflows/publish.yml +43 -0
- cv_renderer-0.1.0/.gitignore +226 -0
- cv_renderer-0.1.0/.python-version +1 -0
- cv_renderer-0.1.0/AGENTS.md +56 -0
- cv_renderer-0.1.0/CLAUDE.md +56 -0
- cv_renderer-0.1.0/LICENSE +201 -0
- cv_renderer-0.1.0/PKG-INFO +260 -0
- cv_renderer-0.1.0/README.md +236 -0
- cv_renderer-0.1.0/docs/references/about-me-section.md +63 -0
- cv_renderer-0.1.0/docs/references/harvard-resume-writing-guide.md +485 -0
- cv_renderer-0.1.0/docs/references/sample-pdfs-harward/2025-template_bullet.docx +0 -0
- cv_renderer-0.1.0/docs/references/sample-pdfs-harward/2025-template_paragraph.docx +0 -0
- cv_renderer-0.1.0/docs/references/sample-pdfs-harward/category-sample.pdf +0 -0
- cv_renderer-0.1.0/docs/references/sample-pdfs-harward/cover-letter-template.pdf +0 -0
- cv_renderer-0.1.0/docs/references/sample-pdfs-harward/resume-sample.pdf +0 -0
- cv_renderer-0.1.0/docs/references/xyz-format-in-resumes.md +149 -0
- cv_renderer-0.1.0/pyproject.toml +60 -0
- cv_renderer-0.1.0/render.py +9 -0
- cv_renderer-0.1.0/src/cv_renderer/__init__.py +0 -0
- cv_renderer-0.1.0/src/cv_renderer/__main__.py +5 -0
- cv_renderer-0.1.0/src/cv_renderer/examples/data/base_en.yaml +98 -0
- cv_renderer-0.1.0/src/cv_renderer/examples/data/base_tr.yaml +92 -0
- cv_renderer-0.1.0/src/cv_renderer/examples/data/labels/en.yaml +12 -0
- cv_renderer-0.1.0/src/cv_renderer/examples/data/labels/tr.yaml +12 -0
- cv_renderer-0.1.0/src/cv_renderer/examples/profiles/ai-engineer.yaml +13 -0
- cv_renderer-0.1.0/src/cv_renderer/examples/profiles/companies/spotify.yaml +49 -0
- cv_renderer-0.1.0/src/cv_renderer/examples/profiles/general.yaml +9 -0
- cv_renderer-0.1.0/src/cv_renderer/examples/tags.yaml +7 -0
- cv_renderer-0.1.0/src/cv_renderer/exports.py +29 -0
- cv_renderer-0.1.0/src/cv_renderer/filter.py +160 -0
- cv_renderer-0.1.0/src/cv_renderer/lint.py +631 -0
- cv_renderer-0.1.0/src/cv_renderer/loader.py +66 -0
- cv_renderer-0.1.0/src/cv_renderer/models.py +128 -0
- cv_renderer-0.1.0/src/cv_renderer/render.py +162 -0
- cv_renderer-0.1.0/src/cv_renderer/templates/main.html.j2 +238 -0
- cv_renderer-0.1.0/tests/__init__.py +0 -0
- cv_renderer-0.1.0/tests/conftest.py +38 -0
- cv_renderer-0.1.0/tests/test_exports.py +17 -0
- cv_renderer-0.1.0/tests/test_filter.py +303 -0
- cv_renderer-0.1.0/tests/test_lint.py +472 -0
- cv_renderer-0.1.0/tests/test_loader.py +47 -0
- cv_renderer-0.1.0/tests/test_models.py +79 -0
- cv_renderer-0.1.0/tests/test_render.py +37 -0
- cv_renderer-0.1.0/uv.lock +659 -0
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Path to your CV data directory.
|
|
2
|
+
# Default: user-data/ inside the repo (created by `uv run python render.py init`)
|
|
3
|
+
# Override if your data lives outside the repo:
|
|
4
|
+
# CV_DATA_DIR=/absolute/path/to/your/cv-data
|
|
5
|
+
CV_DATA_DIR=
|
|
6
|
+
|
|
7
|
+
# Path to write rendered HTML/PDF output.
|
|
8
|
+
# Default: out/ inside the repo
|
|
9
|
+
# CV_OUT_DIR=/absolute/path/to/your/output
|
|
10
|
+
CV_OUT_DIR=
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
concurrency:
|
|
9
|
+
group: ci-${{ github.ref }}
|
|
10
|
+
cancel-in-progress: true
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
quality:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
steps:
|
|
16
|
+
- uses: actions/checkout@v4
|
|
17
|
+
|
|
18
|
+
- name: Install uv
|
|
19
|
+
uses: astral-sh/setup-uv@v5
|
|
20
|
+
with:
|
|
21
|
+
enable-cache: true
|
|
22
|
+
|
|
23
|
+
- name: Install dependencies
|
|
24
|
+
run: uv sync --locked --dev
|
|
25
|
+
|
|
26
|
+
- name: Install Playwright Chromium
|
|
27
|
+
run: uv run playwright install --with-deps chromium
|
|
28
|
+
|
|
29
|
+
- name: Lint (ruff check)
|
|
30
|
+
run: uv run ruff check .
|
|
31
|
+
|
|
32
|
+
- name: Format check (ruff format)
|
|
33
|
+
run: uv run ruff format --check .
|
|
34
|
+
|
|
35
|
+
- name: Type check (mypy)
|
|
36
|
+
run: uv run mypy src/cv_renderer/
|
|
37
|
+
|
|
38
|
+
- name: Tests (pytest)
|
|
39
|
+
run: uv run pytest
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Publish to PyPI on every GitHub Release (tag like v0.1.0).
|
|
2
|
+
#
|
|
3
|
+
# Uses PyPI Trusted Publishing (OIDC) — no API token stored in GitHub.
|
|
4
|
+
# One-time setup on pypi.org: Account → Publishing → add a "pending publisher"
|
|
5
|
+
# for project `cv-renderer`, repo `melisklc0/cv-renderer`, workflow `publish.yml`,
|
|
6
|
+
# environment `pypi`.
|
|
7
|
+
name: Publish
|
|
8
|
+
|
|
9
|
+
on:
|
|
10
|
+
release:
|
|
11
|
+
types: [published]
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
build:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v4
|
|
18
|
+
|
|
19
|
+
- name: Install uv
|
|
20
|
+
uses: astral-sh/setup-uv@v5
|
|
21
|
+
|
|
22
|
+
- name: Build sdist + wheel
|
|
23
|
+
run: uv build
|
|
24
|
+
|
|
25
|
+
- uses: actions/upload-artifact@v4
|
|
26
|
+
with:
|
|
27
|
+
name: dist
|
|
28
|
+
path: dist/
|
|
29
|
+
|
|
30
|
+
publish:
|
|
31
|
+
needs: build
|
|
32
|
+
runs-on: ubuntu-latest
|
|
33
|
+
environment: pypi
|
|
34
|
+
permissions:
|
|
35
|
+
id-token: write # trusted publishing
|
|
36
|
+
steps:
|
|
37
|
+
- uses: actions/download-artifact@v4
|
|
38
|
+
with:
|
|
39
|
+
name: dist
|
|
40
|
+
path: dist/
|
|
41
|
+
|
|
42
|
+
- name: Publish to PyPI
|
|
43
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
# Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
# uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
# poetry.lock
|
|
109
|
+
# poetry.toml
|
|
110
|
+
|
|
111
|
+
# pdm
|
|
112
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
113
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
114
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
115
|
+
# pdm.lock
|
|
116
|
+
# pdm.toml
|
|
117
|
+
.pdm-python
|
|
118
|
+
.pdm-build/
|
|
119
|
+
|
|
120
|
+
# pixi
|
|
121
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
122
|
+
# pixi.lock
|
|
123
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
124
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
125
|
+
.pixi
|
|
126
|
+
|
|
127
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
128
|
+
__pypackages__/
|
|
129
|
+
|
|
130
|
+
# Celery stuff
|
|
131
|
+
celerybeat-schedule
|
|
132
|
+
celerybeat.pid
|
|
133
|
+
|
|
134
|
+
# Redis
|
|
135
|
+
*.rdb
|
|
136
|
+
*.aof
|
|
137
|
+
*.pid
|
|
138
|
+
|
|
139
|
+
# RabbitMQ
|
|
140
|
+
mnesia/
|
|
141
|
+
rabbitmq/
|
|
142
|
+
rabbitmq-data/
|
|
143
|
+
|
|
144
|
+
# ActiveMQ
|
|
145
|
+
activemq-data/
|
|
146
|
+
|
|
147
|
+
# SageMath parsed files
|
|
148
|
+
*.sage.py
|
|
149
|
+
|
|
150
|
+
# Environments
|
|
151
|
+
.env
|
|
152
|
+
.envrc
|
|
153
|
+
.venv
|
|
154
|
+
env/
|
|
155
|
+
venv/
|
|
156
|
+
ENV/
|
|
157
|
+
env.bak/
|
|
158
|
+
venv.bak/
|
|
159
|
+
|
|
160
|
+
# Spyder project settings
|
|
161
|
+
.spyderproject
|
|
162
|
+
.spyproject
|
|
163
|
+
|
|
164
|
+
# Rope project settings
|
|
165
|
+
.ropeproject
|
|
166
|
+
|
|
167
|
+
# mkdocs documentation
|
|
168
|
+
/site
|
|
169
|
+
|
|
170
|
+
# mypy
|
|
171
|
+
.mypy_cache/
|
|
172
|
+
.dmypy.json
|
|
173
|
+
dmypy.json
|
|
174
|
+
|
|
175
|
+
# Pyre type checker
|
|
176
|
+
.pyre/
|
|
177
|
+
|
|
178
|
+
# pytype static type analyzer
|
|
179
|
+
.pytype/
|
|
180
|
+
|
|
181
|
+
# Cython debug symbols
|
|
182
|
+
cython_debug/
|
|
183
|
+
|
|
184
|
+
# PyCharm
|
|
185
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
186
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
187
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
188
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
189
|
+
# .idea/
|
|
190
|
+
|
|
191
|
+
# Abstra
|
|
192
|
+
# Abstra is an AI-powered process automation framework.
|
|
193
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
194
|
+
# Learn more at https://abstra.io/docs
|
|
195
|
+
.abstra/
|
|
196
|
+
|
|
197
|
+
# Visual Studio Code
|
|
198
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
199
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
200
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
201
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
202
|
+
# .vscode/
|
|
203
|
+
# Temporary file for partial code execution
|
|
204
|
+
tempCodeRunnerFile.py
|
|
205
|
+
|
|
206
|
+
# Ruff stuff:
|
|
207
|
+
.ruff_cache/
|
|
208
|
+
|
|
209
|
+
# PyPI configuration file
|
|
210
|
+
.pypirc
|
|
211
|
+
|
|
212
|
+
# Marimo
|
|
213
|
+
marimo/_static/
|
|
214
|
+
marimo/_lsp/
|
|
215
|
+
__marimo__/
|
|
216
|
+
|
|
217
|
+
# Streamlit
|
|
218
|
+
.streamlit/secrets.toml
|
|
219
|
+
|
|
220
|
+
# Rendered CV files
|
|
221
|
+
out/
|
|
222
|
+
|
|
223
|
+
# Personal CV data — tracked in a separate local git repo (user-data/.git)
|
|
224
|
+
user-data/
|
|
225
|
+
|
|
226
|
+
templates/images/*.png
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.13
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# AGENTS.md
|
|
2
|
+
|
|
3
|
+
You are working on cv-renderer: a profile-driven CV renderer that produces tailored HTML and PDF exports from a single YAML data source.
|
|
4
|
+
|
|
5
|
+
## How to Work
|
|
6
|
+
|
|
7
|
+
- Read `user-data/data/base_en.yaml` before touching any CV content or generating profiles — the live data is the source of truth for tags, bullets, and skill categories.
|
|
8
|
+
- Before writing or editing bullets, read `AGENTS.md` and the files under `docs/references/`.
|
|
9
|
+
- Keep changes scoped. A profile change should not touch the template; a bullet edit should not touch filter logic.
|
|
10
|
+
|
|
11
|
+
## Before Changing Common Areas
|
|
12
|
+
|
|
13
|
+
- **Data files** (`base_en.yaml`, `base_tr.yaml`): structural keys and tags are always English, even in `base_tr.yaml`. Never add a tag that doesn't belong to the vocabulary without checking with the user first.
|
|
14
|
+
- **Filter logic** (`src/cv_renderer/filter.py`): changes here affect every profile. Inspect existing behavior before modifying.
|
|
15
|
+
- **Template** (`templates/main.html.j2`): visual-only changes. No content or data logic belongs here.
|
|
16
|
+
- **Profile schema** (`src/cv_renderer/models.py`): adding a field requires updating examples and docs.
|
|
17
|
+
|
|
18
|
+
## Critical Rules for CV Content
|
|
19
|
+
|
|
20
|
+
- Every bullet must follow the XYZ formula. Read `docs/references/xyz-format-in-resumes.md`.
|
|
21
|
+
- Every bullet must follow Harvard OCS language rules. Read `docs/references/harvard-resume-writing-guide.md`.
|
|
22
|
+
- Every `about`/`about_override` summary follows the title → skills & accomplishments → career goals structure in `docs/references/about-me-section.md` — including the closing goals sentence, which the bullet-writing guides above don't cover.
|
|
23
|
+
- No personal pronouns, no passive voice, no vague quantifiers in any bullet.
|
|
24
|
+
- Tags are the only interface between data and profiles. A bullet gets all tags that truthfully apply — multiple tags on one bullet is correct. Do not invent tags outside the current vocabulary unless the user asks.
|
|
25
|
+
- Skill items support the same tagging as bullets (`items: [{text, tags}, ...]`), not just the category-level `tags`. Leave an item untagged when it's generic (always shown); tag it when it should only surface for profiles focused on that tag.
|
|
26
|
+
- Never name the target company anywhere in rendered CV content (`about_override`, bullets, etc.), even in a company-specific profile. A resume is a document that outlives one application and can get reused or shared — "Spotify" in the about section is a cover-letter move, not a CV move. Keep company-specific *content* generic; only the profile filename/metadata should name the company.
|
|
27
|
+
- `user-data/` contains personal data. Never commit it to a public repo.
|
|
28
|
+
|
|
29
|
+
## Profile Generation
|
|
30
|
+
|
|
31
|
+
- Produce valid YAML matching the `Profile` schema in `src/cv_renderer/models.py`.
|
|
32
|
+
- Save company-specific profiles to `user-data/profiles/companies/<company>.yaml`.
|
|
33
|
+
- Do not add fields outside the schema.
|
|
34
|
+
- Company-specific wording (a summary pitch tailored to one job posting) belongs in that profile's `title_override` / `about_override` fields, never patched into `base_en.yaml`/`base_tr.yaml`. The base files stay the single, company-agnostic source of truth; only tag-based selection and per-application overrides live in profiles.
|
|
35
|
+
- Overrides are still real CV content: same XYZ/Harvard rules, no invented facts, and written natively in the profile's `lang` — never a literal translation from the other language file.
|
|
36
|
+
- Tag filtering only selects among existing bullets and includes/excludes whole entries — it cannot reframe an accomplishment. When a job or project is genuinely relevant to the target posting but its base bullets are framed the wrong way (e.g. an AI-tagged project whose data-access-security work matters to a data-engineering posting), rewrite those bullets in `experience_overrides` / `project_overrides` (keyed by `company` / project `name`) rather than editing the base data or forcing tags that don't truthfully apply. An override also forces the entry to appear even if its tags would otherwise exclude it — use this only when something in it is honestly relevant; if nothing is, leave it out and let tag filtering drop it.
|
|
37
|
+
- If a per-application skill grouping (e.g. splitting one base category into two) would only make sense for this one profile, use `skill_overrides`, not a `base_en.yaml`/`base_tr.yaml` category split — the base files are shared by every profile, including `general`, so a split there leaks into CVs that never asked for it.
|
|
38
|
+
|
|
39
|
+
## Checks
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
uv run ruff check .
|
|
43
|
+
uv run ruff format .
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## References
|
|
47
|
+
|
|
48
|
+
Read when relevant:
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
AGENTS.md
|
|
52
|
+
docs/references/xyz-format-in-resumes.md
|
|
53
|
+
docs/references/harvard-resume-writing-guide.md
|
|
54
|
+
docs/references/about-me-section.md
|
|
55
|
+
docs/roadmap.md
|
|
56
|
+
```
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# CLAUDE.md
|
|
2
|
+
|
|
3
|
+
You are working on cv-renderer: a profile-driven CV renderer that produces tailored HTML and PDF exports from a single YAML data source.
|
|
4
|
+
|
|
5
|
+
## How to Work
|
|
6
|
+
|
|
7
|
+
- Read `user-data/data/base_en.yaml` before touching any CV content or generating profiles — the live data is the source of truth for tags, bullets, and skill categories.
|
|
8
|
+
- Before writing or editing bullets, read `AGENTS.md` and the files under `docs/references/`.
|
|
9
|
+
- Keep changes scoped. A profile change should not touch the template; a bullet edit should not touch filter logic.
|
|
10
|
+
|
|
11
|
+
## Before Changing Common Areas
|
|
12
|
+
|
|
13
|
+
- **Data files** (`base_en.yaml`, `base_tr.yaml`): structural keys and tags are always English, even in `base_tr.yaml`. Never add a tag that doesn't belong to the vocabulary without checking with the user first.
|
|
14
|
+
- **Filter logic** (`src/cv_renderer/filter.py`): changes here affect every profile. Inspect existing behavior before modifying.
|
|
15
|
+
- **Template** (`templates/main.html.j2`): visual-only changes. No content or data logic belongs here.
|
|
16
|
+
- **Profile schema** (`src/cv_renderer/models.py`): adding a field requires updating examples and docs.
|
|
17
|
+
|
|
18
|
+
## Critical Rules for CV Content
|
|
19
|
+
|
|
20
|
+
- Every bullet must follow the XYZ formula. Read `docs/references/xyz-format-in-resumes.md`.
|
|
21
|
+
- Every bullet must follow Harvard OCS language rules. Read `docs/references/harvard-resume-writing-guide.md`.
|
|
22
|
+
- Every `about`/`about_override` summary follows the title → skills & accomplishments → career goals structure in `docs/references/about-me-section.md` — including the closing goals sentence, which the bullet-writing guides above don't cover.
|
|
23
|
+
- No personal pronouns, no passive voice, no vague quantifiers in any bullet.
|
|
24
|
+
- Tags are the only interface between data and profiles. A bullet gets all tags that truthfully apply — multiple tags on one bullet is correct. Do not invent tags outside the current vocabulary unless the user asks.
|
|
25
|
+
- Skill items support the same tagging as bullets (`items: [{text, tags}, ...]`), not just the category-level `tags`. Leave an item untagged when it's generic (always shown); tag it when it should only surface for profiles focused on that tag.
|
|
26
|
+
- Never name the target company anywhere in rendered CV content (`about_override`, bullets, etc.), even in a company-specific profile. A resume is a document that outlives one application and can get reused or shared — "Spotify" in the about section is a cover-letter move, not a CV move. Keep company-specific *content* generic; only the profile filename/metadata should name the company.
|
|
27
|
+
- `user-data/` contains personal data. Never commit it to a public repo.
|
|
28
|
+
|
|
29
|
+
## Profile Generation
|
|
30
|
+
|
|
31
|
+
- Produce valid YAML matching the `Profile` schema in `src/cv_renderer/models.py`.
|
|
32
|
+
- Save company-specific profiles to `user-data/profiles/companies/<company>.yaml`.
|
|
33
|
+
- Do not add fields outside the schema.
|
|
34
|
+
- Company-specific wording (a summary pitch tailored to one job posting) belongs in that profile's `title_override` / `about_override` fields, never patched into `base_en.yaml`/`base_tr.yaml`. The base files stay the single, company-agnostic source of truth; only tag-based selection and per-application overrides live in profiles.
|
|
35
|
+
- Overrides are still real CV content: same XYZ/Harvard rules, no invented facts, and written natively in the profile's `lang` — never a literal translation from the other language file.
|
|
36
|
+
- Tag filtering only selects among existing bullets and includes/excludes whole entries — it cannot reframe an accomplishment. When a job or project is genuinely relevant to the target posting but its base bullets are framed the wrong way (e.g. an AI-tagged project whose data-access-security work matters to a data-engineering posting), rewrite those bullets in `experience_overrides` / `project_overrides` (keyed by `company` / project `name`) rather than editing the base data or forcing tags that don't truthfully apply. An override also forces the entry to appear even if its tags would otherwise exclude it — use this only when something in it is honestly relevant; if nothing is, leave it out and let tag filtering drop it.
|
|
37
|
+
- If a per-application skill grouping (e.g. splitting one base category into two) would only make sense for this one profile, use `skill_overrides`, not a `base_en.yaml`/`base_tr.yaml` category split — the base files are shared by every profile, including `general`, so a split there leaks into CVs that never asked for it.
|
|
38
|
+
|
|
39
|
+
## Checks
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
uv run ruff check .
|
|
43
|
+
uv run ruff format .
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## References
|
|
47
|
+
|
|
48
|
+
Read when relevant:
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
AGENTS.md
|
|
52
|
+
docs/references/xyz-format-in-resumes.md
|
|
53
|
+
docs/references/harvard-resume-writing-guide.md
|
|
54
|
+
docs/references/about-me-section.md
|
|
55
|
+
docs/roadmap.md
|
|
56
|
+
```
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Melis Kılıç
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|