rbx-proofreader 1.0.1__py3-none-any.whl → 1.1.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,128 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: rbx-proofreader
3
- Version: 1.0.1
4
- Summary: Visual trade detection and OCR engine
5
- License: MIT
6
- Requires-Python: >=3.12
7
- Description-Content-Type: text/markdown
8
- License-File: LICENSE
9
- Requires-Dist: easyocr>=1.7.0
10
- Requires-Dist: numpy>=1.24.0
11
- Requires-Dist: opencv-python>=4.8.0
12
- Requires-Dist: Pillow>=10.0.0
13
- Requires-Dist: playwright>=1.40.0
14
- Requires-Dist: rapidfuzz>=3.0.0
15
- Requires-Dist: requests>=2.31.0
16
- Requires-Dist: torch>=2.0.0
17
- Requires-Dist: tqdm>=4.66.0
18
- Requires-Dist: transformers>=4.30.0
19
- Requires-Dist: ultralytics>=8.0.0
20
- Dynamic: license-file
21
-
22
- # Proofreader 🔍
23
- High-speed Roblox trade analyzer using **YOLOv11**, **CLIP**, and **EasyOCR** for instant item detection and structured JSON output.
24
-
25
- ![Python](https://img.shields.io/badge/python-3.12-blue.svg)
26
- ![YOLOv11](https://img.shields.io/badge/model-YOLOv11-green.svg)
27
- ![License](https://img.shields.io/badge/license-MIT-red.svg)
28
- ![PyPI](https://img.shields.io/pypi/v/rbx-proofreader?color=blue)
29
- ![Build](https://img.shields.io/badge/build-passing-brightgreen)
30
-
31
- ---
32
-
33
- ## Features
34
- - Detect outgoing and incoming trade items from screenshots
35
- - Outputs structured JSON for automation or analytics
36
- - Supports custom backgrounds and HTML templates
37
- - Trained with YOLOv11 and enhanced with CLIP embeddings
38
- - Easy installation and integration
39
-
40
- ---
41
-
42
- ## Example
43
-
44
- | Input Image | Detected UI Elements |
45
- | ----------- | ------------------ |
46
- | ![](./docs/assets/trade_before.png) | ![](./docs/assets/trade_after.png) |
47
-
48
- **Sample Output JSON:**
49
-
50
- ```json
51
- {
52
- "outgoing": {
53
- "item_count": 4,
54
- "robux_value": 0,
55
- "items": [
56
- {"id": 1031429, "name": "Domino Crown"},
57
- {"id": 72082328, "name": "Red Sparkle Time Fedora"},
58
- {"id": 124730194, "name": "Blackvalk"},
59
- {"id": 16652251, "name": "Red Tango"}
60
- ]
61
- },
62
- "incoming": {
63
- "item_count": 2,
64
- "robux_value": 1048576,
65
- "items": [
66
- {"id": 21070012, "name": "Dominus Empyreus"},
67
- {"id": 22850569, "name": "Red Bandana of SQL Injection"}
68
- ]
69
- }
70
- }
71
- ```
72
-
73
- ## 💻 Quick Start
74
-
75
- ```py
76
- import proofreader
77
-
78
- # Analyze the image
79
- data = proofreader.get_trade_data("test.png")
80
-
81
- # Print the result
82
- print(data)
83
- ```
84
-
85
- ## Installation
86
-
87
- ### Quick Install (Recommended)
88
-
89
- ```bash
90
- pip install rbx-proofreader
91
- ```
92
-
93
- ### From Source (Advanced / Custom Training)
94
-
95
- **1.** Clone the repository.
96
-
97
- **2.** Run `python scripts/setup_items.py` to initialize cache, download thumbnails, and create CLIP embeddings.
98
-
99
- **3.** Place background images in: `src/proofreader/train/emulator/backgrounds`. Use continuous numbering: background_0.jpg, background_1.jpg, ...
100
-
101
- **4.** Place HTML templates in `src/proofreader/train/emulator/templates`. Include both light and dark theme templates.
102
-
103
- **5.** Configure synthetic data generation and YOLO training settings in `src/proofreader/core/config.py`
104
-
105
-
106
- **6.** Run `python scripts/train_model.py`
107
-
108
- > Note: GPU recommended for training. Final model will be saved under `runs/trainX/weights/best.pt`. Rename to `yolo.pt` and move to `src/assets/weights`.
109
-
110
- ## Tech Stack
111
-
112
- - **Python 3.12**
113
-
114
- - **YOLOv11** for fast UI detection
115
-
116
- - **CLIP** for visual embedding matching
117
-
118
- - **EasyOCR** for text extraction
119
-
120
- - **NumPy / OpenCV** for image processing
121
-
122
- ## Contributing
123
-
124
- Contributions are welcome! Please open an issue or submit a pull request.
125
-
126
- ## License
127
-
128
- This project is licensed under the MIT License.
@@ -1,17 +0,0 @@
1
- proofreader/__init__.py,sha256=YVsRxmHmC2nvCrxvNmZX230B1s5k36RFM51kElXSxB4,285
2
- proofreader/main.py,sha256=2QcwgZbJIgugbhJDoLdbeWmKYa9W0BenFoMYYZktyY4,3286
3
- proofreader/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
- proofreader/core/config.py,sha256=Alfe8XA_tTbt68NFshN3ii90Is4AnXagizLgnzIhtik,5682
5
- proofreader/core/detector.py,sha256=em2Kx0v96Zofi4kK5ipWlqMX9czq9YobHuEGuZkAQEc,987
6
- proofreader/core/matcher.py,sha256=-woRSsFjOJ63uwPMSFO61arv739Dz3lE-3dQKwgKxSE,3031
7
- proofreader/core/ocr.py,sha256=pUecOK9mXx9JbMdE_HUHOzFCusWBUKJN-ZCnCdy3TAA,2673
8
- proofreader/core/resolver.py,sha256=DTbf5qyQaJrBbw1QWQQJ_BZf_dg003p_xH8RMpI6sn8,2685
9
- proofreader/core/schema.py,sha256=35Zq7FBssyd1kd_LaloetsTIP2WKvd63ICdMEaDHwb8,2380
10
- proofreader/train/builder.py,sha256=D08wO_xvJATN0L2C7g-MrKwGxchXLe-azAhPO5MvkJM,3658
11
- proofreader/train/train.py,sha256=9X5V2g6gBbI6ci6bEP29pMgsRv35dczX0ctQUkx2Tm0,1006
12
- proofreader/train/emulator/generator.py,sha256=dFNV_NzU3J4iKX5VsAoPulEnJkTo8_BYfjBN1dtrGfQ,7818
13
- rbx_proofreader-1.0.1.dist-info/licenses/LICENSE,sha256=eHSaONn9P_ZcYiY9QCi_XzVARIoQu7l2AI5BtFGA_BY,1069
14
- rbx_proofreader-1.0.1.dist-info/METADATA,sha256=mopkJMulMIo2sCp5Z8HCR3MpB2PE5SkrWGD1suat79Y,3449
15
- rbx_proofreader-1.0.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
16
- rbx_proofreader-1.0.1.dist-info/top_level.txt,sha256=U3s8IVdLtGeGD3JgMmCHUgAsFhZXSSamp3vIojAFTxU,12
17
- rbx_proofreader-1.0.1.dist-info/RECORD,,