Spaces:
Running
license: mit
title: pic-to-header
sdk: streamlit
emoji: ๐จ
colorFrom: blue
colorTo: purple
pinned: false
app_file: pic_to_header/app.py
Pic-to-Header is a Python application that generates header images using a mask image and an input image. Version 0.1.1 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. It also supports a command-line interface (CLI).
โจ Key Features
- Upload mask and input images
- Generate header images
- Preview and download generated header images
- Image processing using a command-line interface (CLI)
- Added README page and release notes page to the Streamlit app
๐ง Usage
Method 1: Installation from PyPI
Pic-to-Header is available on PyPI. You can install it using the following command:
pip install pic-to-header
Method 2: Installation from Source
- Clone the repository:
git clone https://github.com/Sunwood-ai-labs/pic-to-header.git cd pic-to-header
- Install the required dependencies:
pip install -r requirements.txt
Streamlit Web Application
- Start the Streamlit application:
streamlit run pic_to_header/app.py
- Access the URL displayed in your browser.
- Upload your input and mask images.
- Click the "Generate Header Image" button.
- Preview and download the generated header image as needed.
Command-Line Interface (CLI)
You can also process images using the CLI:
pic-to-header input_image.png mask_image.png output_image.png
Example:
pic-to-header assets/sample.png assets/mask.png output_image.png
Using the Python Script
The pic-to-header
package can also be used directly within a Python script. Here's an example:
from pic_to_header.core import process_header_image
# Specify the paths to the input image, mask image, and output image
input_image_path = "path/to/input_image.png"
mask_image_path = "path/to/mask_image.png"
output_image_path = "path/to/output_image.png"
# Generate the header image
result = process_header_image(input_image_path, mask_image_path, output_image_path)
print(f"Header image generated: {result}")
This script works as follows:
- Imports the
process_header_image
function from thepic_to_header.core
module. - Specifies the paths to the input image, mask image, and output image.
- Calls the
process_header_image
function to generate the header image. - Displays the path to the generated image.
Running this script will generate the header image at the specified output path.
๐ป Development
pic_to_header/core.py
: Contains the core image processing functionality.pic_to_header/app.py
: Provides the web interface using Streamlit.pic_to_header/cli.py
: Provides the command-line interface.
๐ฆ Installation Instructions
See the "Usage" section above.
๐ What's New
- Implemented a command-line interface (CLI) for image processing from the command line.
- Added a README page and release notes page to the Streamlit app.
- Improved documentation, adding instructions for installation from PyPI and CLI usage.
- Changed the CLI entry point from
pic_to_header.app:main
topic_to_header.cli:main
. - Version number updated from 0.1.0 to 0.1.1.
๐ License
This project is licensed under the MIT License. See the LICENSE file for details.