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
