docs/README.en.md

---
license: mit
title: Pic-to-Header
sdk: streamlit
emoji: 🐨
colorFrom: blue
colorTo: purple
pinned: false
app_file: pic_to_header/app.py

---

<div align="center">

# Pic-to-Header

![Pic-to-Header Result](https://raw.githubusercontent.com/Sunwood-ai-labs/pic-to-header/refs/heads/main/assets/result.png)

[![GitHub license](https://img.shields.io/github/license/Sunwood-ai-labs/pic-to-header)](https://github.com/Sunwood-ai-labs/pic-to-header/blob/main/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/Sunwood-ai-labs/pic-to-header)](https://github.com/Sunwood-ai-labs/pic-to-header/stargazers)
[![GitHub issues](https://img.shields.io/github/issues/Sunwood-ai-labs/pic-to-header)](https://github.com/Sunwood-ai-labs/pic-to-header/issues)
[![GitHub release](https://img.shields.io/github/release/Sunwood-ai-labs/pic-to-header.svg)](https://GitHub.com/Sunwood-ai-labs/pic-to-header/releases/)
[![GitHub tag](https://img.shields.io/github/tag/Sunwood-ai-labs/pic-to-header.svg)](https://GitHub.com/Sunwood-ai-labs/pic-to-header/tags/)
[![PyPI version](https://badge.fury.io/py/pic-to-header.svg)](https://badge.fury.io/py/pic-to-header)

![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
![Streamlit](https://img.shields.io/badge/Streamlit-FF4B4B?style=for-the-badge&logo=Streamlit&logoColor=white)
![OpenCV](https://img.shields.io/badge/opencv-%23white.svg?style=for-the-badge&logo=opencv&logoColor=white)

</div>

Pic-to-Header is a Python application that generates header images using a mask image and an input image. Version 0.1.0 has been released.

## 🚀 Project Overview

Pic-to-Header is a Streamlit application that allows you to easily generate and download header images using a mask image and an input image. It's also available on PyPI.

## ✨ Key Features

- Upload mask and input images
- Generate header images
- Preview and download generated header images
- Display README.md (within the Streamlit app)
- A calming, dark theme


## 🔧 How to Use

1.  **Installation**:
    ```bash
    pip install -r requirements.txt
    ```
2.  **Run the Streamlit application**:
    ```bash
    streamlit run pic_to-header/app.py
    ```
3. Access the URL displayed in your browser, upload your input and mask images, and click the "Generate Header Image" button.


## 📦 Installation Instructions

1. Clone the repository:
   ```bash
   git clone https://github.com/Sunwood-ai-labs/pic-to-header.git
   cd pic-to-header
   ```
2. Install the necessary dependencies:
   ```bash
   pip install -r requirements.txt
   ```

## 🆕 What's New (v0.1.0)

- The repository name has been changed from `HarmonAI III` to `Pic-to-Header`.
- Added release, tag, and PyPI version badges to the README.
- Automated PyPI package publishing.
- Enhanced functionality and improved design of the Streamlit application.
- Added sample input images, generated sample images, and mask images.


## 📄 License

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