Skip to content

Commit bc7f854

Browse files
committed
docs: add comments to requirements.txt grouping packages by purpose
Organize requirements.txt with section comments explaining which packages are used by which part of the project. Fixes #172
1 parent 54293c2 commit bc7f854

File tree

1 file changed

+138
-55
lines changed

1 file changed

+138
-55
lines changed

requirements.txt

Lines changed: 138 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,138 @@
1-
attrs==23.2.0
2-
certifi==2024.2.2
3-
charset-normalizer==3.3.2
4-
colorama==0.4.6
5-
coloredlogs==15.0.1
6-
EasyProcess==1.1
7-
entrypoint2==1.1
8-
flatbuffers==24.3.25
9-
humanfriendly==10.0
10-
idna==3.6
11-
imageio==2.34.0
12-
jsonschema==4.21.1
13-
jsonschema-specifications==2023.12.1
14-
keyboard==0.13.5
15-
lazy_loader==0.3
16-
llvmlite==0.42.0
17-
MouseInfo==0.1.3
18-
mpmath==1.3.0
19-
mss==9.0.1
20-
networkx==3.2.1
21-
numba==0.59.1
22-
numpy==1.26.4
23-
onnxruntime==1.17.1
24-
opencv-python-headless==4.9.0.80
25-
packaging==24.0
26-
pandas==2.1.1
27-
Pillow==10.0.1
28-
platformdirs==4.2.0
29-
pooch==1.8.1
30-
protobuf==5.26.1
31-
PyAutoGUI==0.9.54
32-
pygame==2.6.1
33-
PyGetWindow==0.0.9
34-
PyMatting==1.1.12
35-
PyMsgBox==1.0.9
36-
pyperclip==1.8.2
37-
pyreadline3==3.4.1
38-
PyRect==0.2.0
39-
pyscreenshot==3.1
40-
PyScreeze==0.1.29
41-
python-dateutil==2.8.2
42-
pytweening==1.0.7
43-
pytz==2023.3.post1
44-
referencing==0.34.0
45-
rembg==2.0.56
46-
requests==2.31.0
47-
rpds-py==0.18.0
48-
scikit-image==0.22.0
49-
scipy==1.12.0
50-
six==1.16.0
51-
sympy==1.12
52-
tifffile==2024.2.12
53-
tqdm==4.66.2
54-
tzdata==2023.3
55-
urllib3==2.2.1
1+
Based on the analysis, here's the updated requirements.txt with comments grouped by purpose/category:
2+
3+
```txt
4+
# ============================================
5+
# CORE TERMINAL/CASINO FRAMEWORK DEPENDENCIES
6+
# ============================================
7+
8+
# Terminal output styling and colors
9+
colorama==0.4.6 # Used by casino/utils.py for colored terminal output
10+
11+
# Enhanced logging with colors
12+
coloredlogs==15.0.1 # Formatted logging output
13+
humanfriendly==10.0 # Human-readable logging (coloredlogs dependency)
14+
15+
# Input handling for enhanced user interaction
16+
keyboard==0.13.5 # Keyboard input detection and handling
17+
18+
# Windows terminal enhancement
19+
pyreadline3==3.4.1 # Readline functionality for Windows terminals
20+
21+
22+
# ============================================
23+
# AUDIO/VISUAL & GAME PRESENTATION
24+
# ============================================
25+
26+
# Game audio and visual effects
27+
pygame==2.6.1 # Sound effects and audio playback for casino games
28+
29+
# Screen automation and GUI interaction
30+
PyAutoGUI==0.9.54 # Screen automation and GUI control
31+
PyGetWindow==0.0.9 # Window management (PyAutoGUI dependency)
32+
PyMsgBox==1.0.9 # Message boxes (PyAutoGUI dependency)
33+
PyRect==0.2.0 # Rectangle operations (PyAutoGUI dependency)
34+
PyScreeze==0.1.29 # Screenshot functionality (PyAutoGUI dependency)
35+
pytweening==1.0.7 # Tweening animations (PyAutoGUI dependency)
36+
pyperclip==1.8.2 # Clipboard operations (PyAutoGUI dependency)
37+
pyscreenshot==3.1 # Screenshot capture (PyAutoGUI dependency)
38+
mss==9.0.1 # Fast screenshot capture (PyAutoGUI dependency)
39+
MouseInfo==0.1.3 # Mouse position info (PyAutoGUI dependency)
40+
EasyProcess==1.1 # Process management (PyAutoGUI dependency)
41+
entrypoint2==1.1 # Entry point utilities (PyAutoGUI dependency)
42+
43+
44+
# ============================================
45+
# CARD IMAGE PROCESSING (rembg dependencies)
46+
# ============================================
47+
48+
# Background removal for card images
49+
rembg==2.0.56 # Remove backgrounds from card images
50+
51+
# Image processing libraries
52+
Pillow==10.0.1 # Image manipulation (rembg dependency)
53+
opencv-python-headless==4.9.0.80 # Computer vision (rembg dependency)
54+
scikit-image==0.22.0 # Image processing algorithms (rembg dependency)
55+
imageio==2.34.0 # Image I/O operations (rembg dependency)
56+
tifffile==2024.2.12 # TIFF image support (rembg dependency)
57+
58+
# Machine learning/AI for image processing
59+
onnxruntime==1.17.1 # ONNX model runtime (rembg dependency)
60+
numpy==1.26.4 # Numerical computing (rembg dependency)
61+
scipy==1.12.0 # Scientific computing (rembg dependency)
62+
63+
# Performance optimization
64+
numba==0.59.1 # JIT compilation for performance (rembg dependency)
65+
llvmlite==0.42.0 # LLVM compiler infrastructure (numba dependency)
66+
67+
# Data fetching and management
68+
pooch==1.8.1 # Data file fetcher (rembg dependency)
69+
70+
# Advanced image matting
71+
PyMatting==1.1.12 # Alpha matting for image composition (rembg dependency)
72+
73+
# Protocol and serialization
74+
protobuf==5.26.1 # Protocol buffers (rembg dependency)
75+
flatbuffers==24.3.25 # FlatBuffers serialization (rembg dependency)
76+
77+
# Mathematical computations
78+
sympy==1.12 # Symbolic mathematics (rembg dependency)
79+
mpmath==1.3.0 # Arbitrary-precision arithmetic (sympy dependency)
80+
81+
82+
# ============================================
83+
# DATA HANDLING & ANALYTICS
84+
# ============================================
85+
86+
# Data analysis and statistics
87+
pandas==2.1.1 # Data manipulation and analysis for game statistics
88+
89+
# Timezone and date handling
90+
python-dateutil==2.8.2 # Date parsing (pandas dependency)
91+
pytz==2023.3.post1 # Timezone support (pandas dependency)
92+
tzdata==2023.3 # Timezone database (pandas dependency)
93+
six==1.16.0 # Python 2/3 compatibility (pandas dependency)
94+
95+
96+
# ============================================
97+
# NETWORK & EXTERNAL COMMUNICATION
98+
# ============================================
99+
100+
# HTTP requests for external services
101+
requests==2.31.0 # HTTP requests for API calls or data fetching
102+
certifi==2024.2.2 # SSL certificates (requests dependency)
103+
charset-normalizer==3.3.2 # Character encoding (requests dependency)
104+
idna==3.6 # Internationalized Domain Names (requests dependency)
105+
urllib3==2.2.1 # HTTP client (requests dependency)
106+
107+
108+
# ============================================
109+
# CONFIGURATION & VALIDATION
110+
# ============================================
111+
112+
# Configuration schema validation
113+
jsonschema==4.21.1 # JSON schema validation for config files
114+
attrs==23.2.0 # Classes without boilerplate (jsonschema dependency)
115+
referencing==0.34.0 # JSON reference resolution (jsonschema dependency)
116+
rpds-py==0.18.0 # Persistent data structures (jsonschema dependency)
117+
jsonschema-specifications==2023.12.1 # JSON schema specs (jsonschema dependency)
118+
119+
120+
# ============================================
121+
# UTILITIES & MISC TOOLS
122+
# ============================================
123+
124+
# Graph algorithms and data structures
125+
networkx==3.2.1 # Graph theory algorithms (potential for game logic)
126+
127+
# Package version handling
128+
packaging==24.0 # Version parsing and comparison
129+
130+
# Platform-specific directory handling
131+
platformdirs==4.2.0 # Platform-appropriate directories
132+
133+
# Progress bars and loading indicators
134+
tqdm==4.66.2 # Progress bars for long operations
135+
136+
# Lazy loading optimization
137+
lazy_loader==0.3 # Lazy loading of modules/resources
138+
```

0 commit comments

Comments
 (0)