Skip to main content

A tool to extract details from business cards and load them into a Python dict.

Project description

bizcard-ai

bizcard-ai is a Python package that extracts information from images of business cards using the OpenAI API. It processes an image file and returns a JSON object containing the extracted details.

Features

  • Extracts text information from business card images.
  • Returns data in a structured JSON format.
  • Includes a graphical user interface (GUI) for easy image uploading and result viewing.

Installation

Install the package using pip:

pip install bizcard-ai

Setup

Before using bizcard-ai, set your OpenAI API key as an environment variable:

export OPENAI_API_KEY=your_openai_api_key

Replace your_openai_api_key with your actual OpenAI API key.

Usage

Extract Information from an Image

Use the get_image_information function to process a business card image and obtain the extracted information:

from bizcard_ai import get_image_information

filepath = 'path_to_your_image.jpg'
info = get_image_information(filepath)
print(info)

Replace 'path_to_your_image.jpg' with the path to your business card image file.

Launch the GUI

To use the graphical interface for uploading a business card image and viewing the results:

from bizcard_ai import load_test_gui

load_test_gui()

This will open a window where you can upload an image and see the extracted information.

License

This project is licensed under the GNU General Public License v3.0.

Contact

For questions or support, please contact kyle.spinelli@gmail.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bizcard_ai-0.1.0.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bizcard_ai-0.1.0-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file bizcard_ai-0.1.0.tar.gz.

File metadata

  • Download URL: bizcard_ai-0.1.0.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for bizcard_ai-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b7b2beaf7659669894b42c2218312c78426241b56b6f3cd5e7fca0825e7dada9
MD5 f0ce445db7f2d1f58076dfee4e751469
BLAKE2b-256 c8d4de086189e9e2ad142357bd351cf2fa56c9fddfc0e3cb00f77bf051a0dc0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for bizcard_ai-0.1.0.tar.gz:

Publisher: publish.yml on KRSpinelli/bizcard_ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bizcard_ai-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: bizcard_ai-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for bizcard_ai-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2867b07750ab00db4c4068cb7bb10b4f0e0d7be1a29812bebfff00d265af7bfc
MD5 20d21fe7c917ec497fed8cd329db0ec7
BLAKE2b-256 16e4d361d38cbfa8c03b08b5b9de0cade6478d0d4fc2a4d71f6fa039a0d87215

See more details on using hashes here.

Provenance

The following attestation bundles were made for bizcard_ai-0.1.0-py3-none-any.whl:

Publisher: publish.yml on KRSpinelli/bizcard_ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page