codeurcv 0.3.0__tar.gz → 0.4.1__tar.gz

codeurcv-0.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 codeurcv contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

codeurcv-0.4.1/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: codeurcv
+Version: 0.4.1
+Summary: A Python library to generate LaTeX resumes from YAML configuration files using Jinja2 templates.
+License: MIT
+License-File: LICENSE
+Keywords: python,digipin,coordinates
+Author: crackedngineer
+Author-email: subhomoyrchoudhury@gmail.com
+Requires-Python: >=3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Security
+Requires-Dist: jinja2 (>=3.1.6)
+Requires-Dist: pydantic (>=2.12.5)
+Requires-Dist: pyyaml (>=6.0.3)
+Requires-Dist: rich (>=14.3.3)
+Requires-Dist: typer (>=0.24.1)
+Project-URL: Documentation, https://github.com/crackedngineer/code-ur-cv/
+Project-URL: Homepage, https://github.com/crackedngineer/code-ur-cv
+Project-URL: Repository, https://github.com/crackedngineer/code-ur-cv
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# 📄 codeurcv
+
+**Turn a simple YAML or JSON file into a professional resume — instantly.**
+
+[![PyPI version](https://badge.fury.io/py/codeurcv.svg)](https://badge.fury.io/py/codeurcv)
+[![Python](https://img.shields.io/pypi/pyversions/codeurcv)](https://pypi.org/project/codeurcv/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![GitHub Action](https://img.shields.io/badge/GitHub%20Action-available-blue?logo=github)](https://github.com/marketplace/actions/codeurcv)
+
+Whether you're a student, working professional, or researcher — write your details once, get a polished PDF resume every time.
+
+</div>
+
+---
+
+## ✨ Features
+
+- **Simple input format** — describe your resume in a human-readable `.yml` or `.json` file. No LaTeX knowledge required.
+- **Premium templates for free** — choose from a curated set of professionally designed resume templates.
+- **GitHub Action** — automate resume generation on every push. Always have an up-to-date PDF in your repo.
+- **Supports all profiles** — students, working professionals, and researchers are all first-class citizens.
+
+---
+
+## 🚀 Quickstart
+
+```yaml
+# config.yml
+basic_details:
+  name: Jane Doe
+  email: jane@example.com
+  phone: "+1 555 000 0000"
+  location: San Francisco, CA
+  linkedin: linkedin.com/in/janedoe
+  github: github.com/janedoe
+
+summary: >
+  Full-stack engineer with 5 years of experience building scalable web applications.
+
+education:
+  - institution: University of California, Berkeley
+    degree: B.S. Computer Science
+    year: 2019
+
+work:
+  - company: Acme Corp
+    role: Senior Engineer
+    start: Jan 2021
+    end: Present
+    highlights:
+      - Led migration to microservices, reducing latency by 40%
+      - Mentored a team of 4 junior engineers
+
+skills:
+  - category: Languages
+    featured: 
+        - Python
+        - TypeScript
+        - Go
+  - category: Tools
+    featured: 
+        - Docker
+        - Kubernetes
+        - PostgreSQL
+```
+
+```bash
+codeurcv generate example/config.yml
+# → resume.pdf
+```
+
+---
+
+## 📦 Installation
+
+```bash
+pip install codeurcv
+```
+
+### Dependencies
+
+`codeurcv` requires two external tools to generate PDFs:
+
+#### Pandoc
+
+Pandoc is a universal document converter used to process templates.
+
+| Platform | Command |
+|----------|---------|
+| Windows | `winget install --id JohnMacFarlane.Pandoc` or `choco install pandoc` |
+| macOS | `brew install pandoc` |
+| Debian/Ubuntu | `sudo apt install pandoc` |
+| Fedora/RHEL | `sudo dnf install pandoc` |
+| Arch/Manjaro | `sudo pacman -S pandoc` |
+
+→ [Full Pandoc installation guide](https://pandoc.org/installing.html)
+
+#### pdflatex (TeX Live / MiKTeX)
+
+pdflatex is the LaTeX engine used to render the final PDF.
+
+| Platform | Command |
+|----------|---------|
+| Windows | `winget install --id MiKTeX.MiKTeX` or `choco install miktex` |
+| macOS | `brew install --cask mactex` |
+| Debian/Ubuntu | `sudo apt install texlive-latex-base` |
+| Fedora/RHEL | `sudo dnf install texlive-latex` |
+| Arch/Manjaro | `sudo pacman -S texlive-basic` |
+| openSUSE | `sudo zypper install texlive-latex` |
+
+→ [TeX Live installation guide](https://www.tug.org/texlive/acquire.html) · [MiKTeX for Windows](https://miktex.org/download)
+
+---
+
+## 🖼️ Templates
+
+| Name | Best For |
+|------|----------|
+| `classic` | All-purpose, clean single column |
+| `modern` | Tech roles, sidebar layout |
+| `academic` | Researchers, publications-focused |
+| `minimalist` | Design roles, typography-forward |
+
+```bash
+codeurcv generate config.yml --template minimalist
+```
+
+---
+
+## 📖 Local Setup
+
+See [SETUP.md](SETUP.md) for full developer setup instructions.
+
+---
+
+## ⚡ GitHub Action
+
+Automate resume generation on every push using the official GitHub Action.
+
+```yaml
+- uses: crackedngineer/codeurcv-action@v1
+  with:
+    file-name: config.yml
+    out-dir: output
+```
+
+→ [codeurcv-action on GitHub](https://github.com/crackedngineer/codeurcv-action) · [View on Marketplace](https://github.com/marketplace/actions/codeurcv-action)
+
+---
+
+## 🤝 Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) — contributions are welcome!
+
+---
+
+## 📜 License
+
+[MIT](LICENSE) © codeurcv contributors

codeurcv-0.4.1/README.md

@@ -0,0 +1,161 @@
+<div align="center">
+
+# 📄 codeurcv
+
+**Turn a simple YAML or JSON file into a professional resume — instantly.**
+
+[![PyPI version](https://badge.fury.io/py/codeurcv.svg)](https://badge.fury.io/py/codeurcv)
+[![Python](https://img.shields.io/pypi/pyversions/codeurcv)](https://pypi.org/project/codeurcv/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![GitHub Action](https://img.shields.io/badge/GitHub%20Action-available-blue?logo=github)](https://github.com/marketplace/actions/codeurcv)
+
+Whether you're a student, working professional, or researcher — write your details once, get a polished PDF resume every time.
+
+</div>
+
+---
+
+## ✨ Features
+
+- **Simple input format** — describe your resume in a human-readable `.yml` or `.json` file. No LaTeX knowledge required.
+- **Premium templates for free** — choose from a curated set of professionally designed resume templates.
+- **GitHub Action** — automate resume generation on every push. Always have an up-to-date PDF in your repo.
+- **Supports all profiles** — students, working professionals, and researchers are all first-class citizens.
+
+---
+
+## 🚀 Quickstart
+
+```yaml
+# config.yml
+basic_details:
+  name: Jane Doe
+  email: jane@example.com
+  phone: "+1 555 000 0000"
+  location: San Francisco, CA
+  linkedin: linkedin.com/in/janedoe
+  github: github.com/janedoe
+
+summary: >
+  Full-stack engineer with 5 years of experience building scalable web applications.
+
+education:
+  - institution: University of California, Berkeley
+    degree: B.S. Computer Science
+    year: 2019
+
+work:
+  - company: Acme Corp
+    role: Senior Engineer
+    start: Jan 2021
+    end: Present
+    highlights:
+      - Led migration to microservices, reducing latency by 40%
+      - Mentored a team of 4 junior engineers
+
+skills:
+  - category: Languages
+    featured: 
+        - Python
+        - TypeScript
+        - Go
+  - category: Tools
+    featured: 
+        - Docker
+        - Kubernetes
+        - PostgreSQL
+```
+
+```bash
+codeurcv generate example/config.yml
+# → resume.pdf
+```
+
+---
+
+## 📦 Installation
+
+```bash
+pip install codeurcv
+```
+
+### Dependencies
+
+`codeurcv` requires two external tools to generate PDFs:
+
+#### Pandoc
+
+Pandoc is a universal document converter used to process templates.
+
+| Platform | Command |
+|----------|---------|
+| Windows | `winget install --id JohnMacFarlane.Pandoc` or `choco install pandoc` |
+| macOS | `brew install pandoc` |
+| Debian/Ubuntu | `sudo apt install pandoc` |
+| Fedora/RHEL | `sudo dnf install pandoc` |
+| Arch/Manjaro | `sudo pacman -S pandoc` |
+
+→ [Full Pandoc installation guide](https://pandoc.org/installing.html)
+
+#### pdflatex (TeX Live / MiKTeX)
+
+pdflatex is the LaTeX engine used to render the final PDF.
+
+| Platform | Command |
+|----------|---------|
+| Windows | `winget install --id MiKTeX.MiKTeX` or `choco install miktex` |
+| macOS | `brew install --cask mactex` |
+| Debian/Ubuntu | `sudo apt install texlive-latex-base` |
+| Fedora/RHEL | `sudo dnf install texlive-latex` |
+| Arch/Manjaro | `sudo pacman -S texlive-basic` |
+| openSUSE | `sudo zypper install texlive-latex` |
+
+→ [TeX Live installation guide](https://www.tug.org/texlive/acquire.html) · [MiKTeX for Windows](https://miktex.org/download)
+
+---
+
+## 🖼️ Templates
+
+| Name | Best For |
+|------|----------|
+| `classic` | All-purpose, clean single column |
+| `modern` | Tech roles, sidebar layout |
+| `academic` | Researchers, publications-focused |
+| `minimalist` | Design roles, typography-forward |
+
+```bash
+codeurcv generate config.yml --template minimalist
+```
+
+---
+
+## 📖 Local Setup
+
+See [SETUP.md](SETUP.md) for full developer setup instructions.
+
+---
+
+## ⚡ GitHub Action
+
+Automate resume generation on every push using the official GitHub Action.
+
+```yaml
+- uses: crackedngineer/codeurcv-action@v1
+  with:
+    file-name: config.yml
+    out-dir: output
+```
+
+→ [codeurcv-action on GitHub](https://github.com/crackedngineer/codeurcv-action) · [View on Marketplace](https://github.com/marketplace/actions/codeurcv-action)
+
+---
+
+## 🤝 Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) — contributions are welcome!
+
+---
+
+## 📜 License
+
+[MIT](LICENSE) © codeurcv contributors

{codeurcv-0.3.0 → codeurcv-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "codeurcv"
-version = "0.3.0"
+version = "0.4.1"
 description = "A Python library to generate LaTeX resumes from YAML configuration files using Jinja2 templates."
 authors = [
     { name = "crackedngineer", email = "subhomoyrchoudhury@gmail.com" },

{codeurcv-0.3.0 → codeurcv-0.4.1}/src/codeurcv/cli.py

@@ -4,7 +4,7 @@ from rich.console import Console
 from importlib.metadata import version
 
 from .core.renderer import ResumeRenderer
-from .core.constants import DEFAULT_CONFIG_FILE, DEFAULT_OUT_DIR
+from .core.constants import DEFAULT_CONFIG_FILE, DEFAULT_OUT_DIR, DEFAULT_OUTPUT_FILENAME, DEFAULT_TEMPLATE
 
 app = typer.Typer(help="Generate LaTeX resumes from YAML configs.")
 console = Console()
@@ -39,19 +39,26 @@ def main(
 
 @app.command()
 def run(
-    filename: Path = typer.Option(
-        DEFAULT_CONFIG_FILE, "--file", "-f", help="Path to resume YAML config"
+    input: Path = typer.Argument(
+        DEFAULT_CONFIG_FILE, help="Path to your resume YAML or JSON"
     ),
-    out_dir: Path = typer.Option(
-        DEFAULT_OUT_DIR, "--out-dir", "-o", help="Directory to save generated resume"
+    output: Path = typer.Option(
+        DEFAULT_OUT_DIR, "--out", "-o", help="Output directory for the generated PDF"
+    ),
+    # Overrides — only needed if user wants to deviate from config values
+    name: str = typer.Option(
+        DEFAULT_OUTPUT_FILENAME, "--name", "-n", help="Override the output filename"
+    ),
+    template: str = typer.Option(
+        DEFAULT_TEMPLATE, "--template", "-t", help="Override the template defined in config"
     ),
 ):
-    """Render resume."""
+    """Render your resume from a YAML config."""
     console.print("[bold cyan]Starting resume generation...[/bold cyan]")
 
     renderer = ResumeRenderer()
 
-    renderer.render(filename, out_dir)
+    renderer.render(config_path=input, output_dir=output, out_filename=name, template=template)
 
     console.print("[bold green]Done![/bold green]")
 

{codeurcv-0.3.0 → codeurcv-0.4.1}/src/codeurcv/core/constants.py

@@ -1,3 +1,4 @@
 DEFAULT_CONFIG_FILE = "config.yml"
 DEFAULT_TEMPLATE = "minimalist"
-DEFAULT_OUT_DIR = "output"
+DEFAULT_OUT_DIR = "output"
+DEFAULT_OUTPUT_FILENAME = "resume"

{codeurcv-0.3.0 → codeurcv-0.4.1}/src/codeurcv/core/renderer.py

@@ -12,6 +12,7 @@ from codeurcv.core.plugin_loader import load_builtin_plugins
 from codeurcv.core.schema import ResumeConfig
 from codeurcv.core.settings import console
 from codeurcv.core.dependency_checker import check_dependencies
+from codeurcv.core.constants import DEFAULT_OUTPUT_FILENAME
 
 class ResumeRenderer:
     def __init__(self):
@@ -23,7 +24,7 @@ class ResumeRenderer:
         self.log_file = log_dir / f"codeurcv_{timestamp}.log"
         self.logger = setup_logger(debug=False, log_file=self.log_file)
 
-    def render(self, config_path: Path, output_dir: Path):
+    def render(self, config_path: Path, output_dir: Path, out_filename: str = DEFAULT_OUTPUT_FILENAME, template: str = None):
         console.print("\n[bold green]🚀 Building your resume...[/bold green]\n")
 
         try:
@@ -41,8 +42,8 @@ class ResumeRenderer:
 
             # STEP 3
             plugin = self._step(
-                f"Template applied: {config.template}",
-                lambda: self._get_plugin(config.template),
+                f"Template applied: {template}",
+                lambda: self._get_plugin(template),
             )
 
             # STEP 4
@@ -62,19 +63,19 @@ class ResumeRenderer:
             output_dir.mkdir(parents=True, exist_ok=True)
             with tempfile.TemporaryDirectory() as tmpdir:
                 tmp_path = Path(tmpdir)
-                tex_file = tmp_path / f"{config.filename}.tex"
+                tex_file = tmp_path / f"{out_filename}.tex"
                 tex_file.write_text(plugin.postprocess(rendered_tex))
 
                 self._generate_pdf(tex_file, tmp_path)
 
-                final_pdf = output_dir / f"{config.filename}.pdf"
-                shutil.copy(tmp_path / f"{config.filename}.pdf", final_pdf)
+                final_pdf = output_dir / f"{out_filename}.pdf"
+                shutil.copy(tmp_path / f"{out_filename}.pdf", final_pdf)
 
 
             console.print("\n[bold green]✔ PDF generated[/bold green]\n")
             console.print("[bold green]🎉 Done![/bold green]")
             console.print(
-                f"[cyan]📁 {output_dir.resolve() / f'{config.filename}.pdf'}[/cyan]\n"
+                f"[cyan]📁 {output_dir.resolve() / f'{out_filename}.pdf'}[/cyan]\n"
             )
 
         except Exception:

{codeurcv-0.3.0 → codeurcv-0.4.1}/src/codeurcv/core/schema.py

@@ -43,16 +43,9 @@ class Skill(ResumeSection):
     featured_skills: List[str] = Field(default_factory=list)
 
 class ResumeConfig(BaseModel):
-    template: str = DEFAULT_TEMPLATE
-    filename: str = "resume"
     basic_details: BasicDetails
     summary: Optional[str] = None
     education: List[Education] = Field(default_factory=list)
     work: List[Job] = Field(default_factory=list)
     projects: List[Project] = Field(default_factory=list)
     skills: List[Skill] = Field(default_factory=list)
-
-    @field_validator("filename")
-    @classmethod
-    def strip_pdf_extension(cls, v: str) -> str:
-        return v.removesuffix(".pdf")

codeurcv-0.3.0/PKG-INFO

@@ -1,44 +0,0 @@
-Metadata-Version: 2.4
-Name: codeurcv
-Version: 0.3.0
-Summary: A Python library to generate LaTeX resumes from YAML configuration files using Jinja2 templates.
-License: MIT
-Keywords: python,digipin,coordinates
-Author: crackedngineer
-Author-email: subhomoyrchoudhury@gmail.com
-Requires-Python: >=3.12
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Operating System :: OS Independent
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Security
-Requires-Dist: jinja2 (>=3.1.6)
-Requires-Dist: pydantic (>=2.12.5)
-Requires-Dist: pyyaml (>=6.0.3)
-Requires-Dist: rich (>=14.3.3)
-Requires-Dist: typer (>=0.24.1)
-Project-URL: Documentation, https://github.com/crackedngineer/code-ur-cv/
-Project-URL: Homepage, https://github.com/crackedngineer/code-ur-cv
-Project-URL: Repository, https://github.com/crackedngineer/code-ur-cv
-Description-Content-Type: text/markdown
-
-# Subhomoy Roy Choudhury Resume
-
-## Local Setup
-
-To build and compile the resume locally using Docker:
-
-1. **Build the Docker image:**
-    ```bash
-    make docker-build
-    ```
-
-2. **Compile the LaTeX resume inside the container:**
-    ```bash
-    docker run --rm -v $(pwd):/workspace ghcr.io/youruser/latex-ci:latest make compile
-    ```
-
-> Ensure you have [Docker](https://www.docker.com/) and [Make](https://www.gnu.org/software/make/) installed on your system.
-
-The compiled PDF will be available in your project directory.

codeurcv-0.3.0/README.md

@@ -1,19 +0,0 @@
-# Subhomoy Roy Choudhury Resume
-
-## Local Setup
-
-To build and compile the resume locally using Docker:
-
-1. **Build the Docker image:**
-    ```bash
-    make docker-build
-    ```
-
-2. **Compile the LaTeX resume inside the container:**
-    ```bash
-    docker run --rm -v $(pwd):/workspace ghcr.io/youruser/latex-ci:latest make compile
-    ```
-
-> Ensure you have [Docker](https://www.docker.com/) and [Make](https://www.gnu.org/software/make/) installed on your system.
-
-The compiled PDF will be available in your project directory.