Merge pull request #334 from apiraino/add-pdf-skip-script-param

Add pdf skip script param

Author: Kobzol

annual-survey.md

@@ -58,13 +58,10 @@ $ source venv/bin/activate
 (venv) $ pip install -U pillow # this might be needed if the code fails
 ```
 
-#### PDF report
-To generate the report, copy the `main.py` file from the previous year, go through all questions and patch up the question IDs to match the contents of the actual survey (questions can move around, be added or removed, so it needs manual analysis). After the questions are patched, a PDF report will be generated by the Python file. 
-
-After the PDF report is prepared, send a PR to the [surveys](https://github.com/rust-lang/surveys) repository.
-
 #### Blog post
-The same Python file is also used to render a blog post. The way it works is that we use a template Markdown file (e.g. `surveys/2023-annual-survey/report/2024-02-19-2023-Rust-Annual-Survey-2023-results.md`) with the contents of the blog post, which is rendered by the `main.py` script. The render process adds charts to the blog post and copies all the used image files and the final rendered Markdown file into a checkout of the [blog repository][blog repository], which you must have somewhere at your filesystem.
+To generate the blog post, copy the `main.py` file from the previous year, go through all questions and patch up the question IDs to match the contents of the actual survey (questions can move around, be added or removed, so it needs manual analysis). After the questions are patched, run the python script. Optionally with `--skip-pdf` to skip the PDF report generation.
+
+The way it works is that we use a template Markdown file (e.g. `surveys/2023-annual-survey/report/2024-02-19-2023-Rust-Annual-Survey-2023-results.md`) with the contents of the blog post, which is rendered by the `main.py` script. The render process adds charts to the blog post and copies all the used image files and the final rendered Markdown file into a checkout of the [blog repository][blog repository], which you must have somewhere at your filesystem.
 
 To test the contents of the rendered blog post, you have to run the `main.py` script, then run `cargo run` in the blog repository directory and open the built HTML file in your browser of choice. Note that for faster feedback, I would recommend commenting out the rendering of the PDF in `main.py` (which is relatively slow) when making frequent changes to the blog post template.
 
@@ -75,3 +72,8 @@ After the blog post is prepared, send a PR to the [blog repository][blog reposit
 You will then also need to update the blog template in the `surveys` repo, but that can be done asynchronously.
 
 [blog repository]: https://github.com/rust-lang/blog.rust-lang.org
+
+#### PDF report
+To also generate the PDF report, run the python script without additional parameters.
+
+After the PDF report is prepared, send a PR to the [surveys](https://github.com/rust-lang/surveys) repository.

surveys/2024-annual-survey/report/main.py

@@ -461,19 +461,24 @@ def annual_survey_2024_report() -> ChartReport:
 
     report = annual_survey_2024_report()
 
-    render_report_to_pdf(
-        report,
-        Path(__file__).parent / "annual-survey-2024-report.pdf",
-        "Rust Annual survey 2024 report",
-        include_labels=False
-    )
-
     resource_dir = "2025-02-13-rust-survey-2024"
     # Fill path to blog root (i.e. a checkout of https://github.com/rust-lang/blog.rust-lang.org)
     blog_root = Path("/projects/personal/rust/blog.rust-lang.org")
+    # relative path in this repository where the survey Markdown template is
+    template_path = Path("surveys/2024-annual-survey/report/2025-02-13-2024-State-Of-Rust-Survey-results.md")
     render_blog_post(
-        template=Path("2025-02-13-2024-State-Of-Rust-Survey-results.md"),
+        template=template_path,
         blog_root=blog_root,
         resource_dir=resource_dir,
         report=report
     )
+
+    if len(sys.argv) == 2 and sys.argv[1] == "--skip-pdf":
+        sys.exit(0)
+
+    render_report_to_pdf(
+        report,
+        Path(__file__).parent / "annual-survey-2024-report.pdf",
+        "Rust Annual survey 2024 report",
+        include_labels=False
+    )