sheikh-huzaif-resume 1.0.1

A CLI tool to present my CV

Terminal Resume

A modern, interactive Python CLI tool that displays your professional resume in a beautifully formatted terminal interface.

✨ Features

• 🎨 Beautiful Output - Rich text formatting with colors, tables, and panels
• 🚀 Fast & Lightweight - Built with Typer for optimal performance
• 💼 Professional Display - Showcase work experience, projects, skills, and education
• 📱 Contact Information - Easy access to your contact details
• 🧪 Well Tested - Comprehensive test suite with pytest
• 📦 Easy Distribution - Install via pip
• 🎯 Type Safe - Full type hints for better IDE support

📦 Installation

From PyPI (when published)

pip install sheikh-huzaif-resume

From Source

git clone https://github.com/sheikhhuzaif/terminal-resume
cd terminal-resume
pip install -e .

For Development

pip install -e ".[dev]"
# or
make install-dev

🚀 Quick Start

After installation, you can use the CLI:

# Show help
resume --help

# Show version
resume --version

# Display contact information
resume contact

# Show professional summary
resume summary

# View work experience
resume work-exp

# Browse projects
resume projects

# Display education
resume education

# List skills
resume skills

# Show tool info
resume info

📖 Commands

contact

Display contact information including email, phone, LinkedIn, and GitHub.

resume contact

summary

Show professional summary and career overview.

resume summary

work-exp

View detailed work experience with companies, roles, and achievements.

resume work-exp

projects

Browse personal projects with descriptions, technologies, and links.

resume projects

education

Display educational background and qualifications.

resume education

skills

List technical skills organized by categories (languages, frameworks, tools, etc.).

resume skills

info

Display information about the CLI tool.

resume info
resume info --verbose

🏗️ Project Structure

terminal-resume/
├── src/
│   └── resume/
│       ├── __init__.py
│       ├── cli.py              # Main CLI entry point
│       ├── data.py             # Resume data store
│       ├── commands/           # Command implementations
│       │   ├── __init__.py
│       │   ├── contact.py
│       │   ├── summary.py
│       │   ├── work_exp.py
│       │   ├── projects.py
│       │   ├── education.py
│       │   ├── skills.py
│       │   └── info.py
│       └── utils/              # Utility functions
│           ├── __init__.py
│           └── helpers.py
├── tests/                      # Test suite
│   ├── __init__.py
│   ├── test_helpers.py
│   └── test_commands.py
├── requirements/
│   ├── requirements.txt        # Production dependencies
│   └── requirements-dev.txt    # Development dependencies
├── setup.py                    # Setup configuration
├── pyproject.toml             # Modern Python project config
├── pytest.ini                 # Pytest configuration
├── Makefile                   # Convenient commands
├── LICENSE                    # MIT License
└── README.md

🛠️ Development

Setup Development Environment

# Clone the repository
git clone https://github.com/sheikhhuzaif/terminal-resume.git
cd terminal-resume

# Install development dependencies
make install-dev

# Or manually
pip install -e ".[dev]"

Running Tests

# Run all tests
make test

# Run with coverage
make test-cov

# Or directly with pytest
pytest
pytest --cov=resume --cov-report=html

Code Quality

# Format code with Black
make format

# Lint code
make lint

# Or run individually
black src/resume tests
flake8 src/resume tests
mypy src/resume

Running Locally

# Run directly
python -m resume.cli

# Or after installation
resume

# Using make
make run

🔧 Adding New Commands

1. Create a new file in src/resume/commands/:

# src/resume/commands/mycommand.py
import typer
from rich.console import Console

console = Console()

def main(
    verbose: bool = typer.Option(False, "--verbose", "-v", help="Verbose output")
):
    """
    Description of your command.
    """
    console.print("[green]Command executed successfully![/green]")

2. Register it in src/resume/cli.py:

from .commands import contact, summary, mycommand

app.command(name="mycommand")(mycommand.main)

3. Add tests in tests/test_commands.py

📦 Building and Publishing

Build Distribution

# Build wheel and source distribution
make build

# Or manually
python -m build

Publish to PyPI

# Test on TestPyPI first
make publish-test

# Publish to PyPI
make publish

# Or manually with twine
python -m twine upload dist/*

🧰 Dependencies

Core Dependencies

• typer[all]==0.9.0 - CLI framework with great UX
• rich==13.7.0 - Beautiful terminal formatting
• questionary==2.0.1 - Interactive prompts
• pyfiglet==1.0.2 - ASCII art text

Development Dependencies

• pytest==7.4.3 - Testing framework
• pytest-cov==4.1.0 - Code coverage
• black==23.12.1 - Code formatter
• flake8==7.0.0 - Linter
• mypy==1.8.0 - Type checker

📝 License

MIT License - see LICENSE file for details

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📧 Contact

Sheikh Huzaif - [e-mail]

Project Link: https://github.com/sheikhhuzaif/terminal-resume