Metadata-Version: 2.4
Name: gitresume
Version: 0.0.1
Summary: Generate professional resumes from your GitHub repositories.
Project-URL: Homepage, https://github.com/WhoIsJayD/gitresume
Project-URL: Repository, https://github.com/WhoIsJayD/gitresume
Project-URL: Issues, https://github.com/WhoIsJayD/gitresume/issues
Author-email: Jaydeep Solanki <contactjaydeepsolanki@gmail.com>
License: MIT
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: aiofiles>=24.1.0
Requires-Dist: diskcache>=5.6.3
Requires-Dist: fastapi>=0.128.0
Requires-Dist: jinja2>=3.1.6
Requires-Dist: litellm>=1.81.7
Requires-Dist: pydantic>=2.12.5
Requires-Dist: pygithub>=2.8.1
Requires-Dist: rich>=14.3.2
Requires-Dist: tenacity>=9.0.0
Requires-Dist: tree-sitter-c-sharp>=0.23.1
Requires-Dist: tree-sitter-cpp>=0.23.4
Requires-Dist: tree-sitter-go>=0.25.0
Requires-Dist: tree-sitter-java>=0.23.5
Requires-Dist: tree-sitter-javascript>=0.25.0
Requires-Dist: tree-sitter-python>=0.25.0
Requires-Dist: tree-sitter-rust>=0.24.0
Requires-Dist: tree-sitter-typescript>=0.23.2
Requires-Dist: tree-sitter>=0.25.2
Requires-Dist: typer>=0.12.0
Requires-Dist: uvicorn>=0.40.0
Description-Content-Type: text/markdown

# 🚀 GitResume

*Transform your GitHub repositories into professional, ATS-optimized resumes using AI.*

GitResume is a CLI tool that analyzes your local or remote repositories, extracts technical achievements, and generates impactful resume bullet points, tech stack summaries, and interview preparation materials.

<div align="center">
  <img src="https://raw.githubusercontent.com/WhoIsJayD/gitresume/main/docs/images/cli_demo.png" alt="GitResume CLI Demo" width="100%"/>
  <p><em>(Placeholder for Rich UI Screenshot)</em></p>
</div>

<div align="center">

[![PyPI version](https://img.shields.io/pypi/v/gitresume.svg)](https://pypi.org/project/gitresume/)
[![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://choosealicense.com/licenses/mit/)
[![Build Status](https://github.com/whoisjayd/gitresume/actions/workflows/build.yml/badge.svg)](https://github.com/whoisjayd/gitresume/actions/workflows/build.yml)
[![Docker Image Version](https://img.shields.io/docker/v/whoisjayd/gitresume?label=docker)](https://hub.docker.com/r/whoisjayd/gitresume)
[![GitHub Issues](https://img.shields.io/github/issues/whoisjayd/gitresume)](https://github.com/whoisjayd/gitresume/issues)

</div>

---

## ✨ Features

- **🔍 Deep Analysis**: Uses Tree-sitter to parse your code and understand the actual technical complexity.
- **🤖 Multi-LLM Support**: Integrates with Gemini, OpenAI, Anthropic, and Groq via LiteLLM.
- **📄 Multiple Formats**: Generates resumes in Markdown and structured JSON.
- **💻 Local-First**: No need to upload your code to a 3rd party service. Analysis happens on your machine.
- **📊 Web Dashboard**: View your generated resumes and analysis history in a beautiful local web interface.
- **🎯 Job Tailoring**: Provide a job description to generate targeted achievements.

---

## 🚀 Quick Start

### Installation

Choose your preferred installation method:

#### 1. Via `uv` (Recommended)
```bash
uv tool install gitresume
```

#### 2. Via `pip`
```bash
pip install gitresume
```

#### 3. Via Docker
```bash
docker pull whoisjayd/gitresume
```

---

## 📖 Usage

### 1. Analyze a Repository
Point GitResume at any local folder or clone a remote repo to create an analysis artifact.

```bash
# Local
gitresume analyze ./my-awesome-project

# Docker
docker run -v $(pwd):/app/data -e GEMINI_API_KEY=$GEMINI_API_KEY whoisjayd/gitresume analyze /app/data/my-project
```

### 2. Generate a Resume
Use the analysis to generate a polished resume. You can optionally provide a job description for better targeting.

```bash
gitresume generate ./artifacts/my-awesome-project-run-id --jd "Senior Backend Engineer at Google"
```

### 3. View in Dashboard
Start the local dashboard to browse your artifacts and view your resumes.

```bash
gitresume web
```

---

## 🔧 Configuration

GitResume uses environment variables for API keys. You can set them in your shell or use an `.env` or `env.yaml` file.

See the [Configuration Guide](docs/configuration.md) for a full list of environment variables.

| Variable | Description |
|----------|-------------|
| `GEMINI_API_KEY` | Required for Gemini models (Default) |
| `OPENAI_API_KEY` | Required for OpenAI models |
| `ANTHROPIC_API_KEY`| Required for Claude models |
| `GITRESUME_MODEL`| Model string (e.g., `gemini/gemini-1.5-flash`) |

---

## 🏗 CLI Reference

For detailed command usage, see the [CLI Reference](docs/installation.md#cli-reference).

---

## 📄 Documentation

- [Installation & Setup](docs/installation.md)
- [Configuration Guide](docs/configuration.md)
- [Security & Data Handling](docs/security.md)
- [Release Process](docs/release.md)

---

## 🤝 Contributing

We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

## 📜 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---
Created with ❤ by [Jaydeep Solanki](https://github.com/whoisjayd).
