MikeMai commited on
Commit
d721248
·
verified ·
1 Parent(s): 43a0931

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -48
README.md CHANGED
@@ -1,48 +1,13 @@
1
- # Certificate Management API
2
-
3
- A powerful API for extracting and comparing certificate details from PDF and image files. This application uses advanced OCR and AI capabilities to process certificates and provide detailed comparisons.
4
-
5
- ## Features
6
-
7
- - Extract text from PDF certificates (both text-based and scanned)
8
- - Process image-based certificates (JPG, JPEG, PNG)
9
- - Extract key certificate details including:
10
- - Certificate Name
11
- - Certificate ID
12
- - Ship Name
13
- - Date of Issue
14
- - Expiration Date
15
- - Compare multiple certificates and highlight differences
16
- - User-friendly Gradio interface
17
-
18
- ## Setup
19
-
20
- 1. Clone this repository
21
- 2. Install dependencies:
22
- ```bash
23
- pip install -r requirements.txt
24
- ```
25
- 3. Set up your OpenAI API key in a `.env` file:
26
- ```
27
- OPENAI_API_KEY=your_api_key_here
28
- ```
29
- 4. Run the application:
30
- ```bash
31
- python app.py
32
- ```
33
-
34
- ## Usage
35
-
36
- 1. Upload a certificate file (PDF or image)
37
- 2. Optionally, provide old certificate details for comparison
38
- 3. View extracted details and comparison results
39
-
40
- ## Requirements
41
-
42
- - Python 3.8+
43
- - OpenAI API key
44
- - Poppler (for PDF processing)
45
-
46
- ## License
47
-
48
- MIT License
 
1
+ ---
2
+ title: Certificate Management API
3
+ emoji: 💻
4
+ colorFrom: green
5
+ colorTo: blue
6
+ sdk: gradio
7
+ sdk_version: 5.23.3
8
+ app_file: app.py
9
+ pinned: false
10
+ license: mit
11
+ ---
12
+
13
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference