Skip to content

Commit 62f20d4

Browse files
committed
docs: Replace hardcoded gRPC references with jar_exclusions.txt
- Update workflow files to reference jar_exclusions.txt instead of specific exclusions - Update build scripts and Dockerfile to use generic exclusion language - Update all documentation files to point to jar_exclusions.txt - Makes documentation more maintainable when exclusions change - Files updated: test workflow, Dockerfile.build, setup_jars.py, build.sh, README.md, distributions.md, troubleshooting.md, contributing.md
1 parent 3dedbc8 commit 62f20d4

8 files changed

Lines changed: 13 additions & 17 deletions

File tree

.github/workflows/test-python-bindings.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ jobs:
264264
fi
265265
266266
echo "- **Platform**: ${{ matrix.platform }}" >> $GITHUB_STEP_SUMMARY
267-
echo "- **Features**: All ArcadeDB features except gRPC wire protocol" >> $GITHUB_STEP_SUMMARY
267+
echo "- **Features**: All ArcadeDB features (some JARs excluded, see jar_exclusions.txt)" >> $GITHUB_STEP_SUMMARY
268268
269269
- name: Upload test results
270270
if: always()

bindings/python/Dockerfile.build

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Docker build for ArcadeDB Python package
22
# Builds arcadedb-embedded package with bundled JRE (no external Java required)
3-
# Uses original ArcadeDB distribution but excludes gRPC wire protocol to optimize size
3+
# Excludes JARs listed in jar_exclusions.txt to optimize size
44
#
55
# REQUIRED BUILD ARGS (passed from build.sh):
66
# PACKAGE_NAME - always: arcadedb-embedded
@@ -15,7 +15,7 @@ ARG ARCADEDB_TAG=25.10.1-SNAPSHOT
1515
ARG TARGET_PLATFORM=linux-x64
1616

1717
# Stage 1: Use prebuilt ArcadeDB image to obtain compiled JARs
18-
# We use the original distribution and selectively exclude only gRPC for Python use cases
18+
# JARs are filtered based on jar_exclusions.txt in later stages
1919
FROM arcadedata/arcadedb:${ARCADEDB_TAG} AS java-builder
2020

2121
# nothing to do here; jars will be copied from /home/arcadedb/lib in the python-builder stage

bindings/python/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ The `arcadedb-embedded` package (162MB wheel, ~240MB installed) includes everyth
8787
- **Bundled JRE** (~39MB): Custom Java 21 runtime (jlink, 21 modules)
8888
- **Total:** 162MB compressed wheel, ~240MB when installed
8989

90-
**Note**: gRPC wire protocol is excluded to keep package size manageable. We may add it in future versions if needed.
90+
**Note**: Some JARs are excluded to optimize package size. See `jar_exclusions.txt` for details.
9191

9292
Import: `import arcadedb_embedded as arcadedb`
9393

@@ -132,7 +132,7 @@ Supported platforms: `linux/amd64`, `linux/arm64`, `darwin/amd64`, `darwin/arm64
132132
> **Note:** `linux/arm64` uses QEMU emulation for builds. Additional platforms like `windows/arm64` may be added in future releases if demand justifies it.
133133
134134
!!! note "Package Contents"
135-
The package includes all ArcadeDB features except gRPC wire protocol. We don't need gRPC at this moment, and we might add it in future versions if needed.
135+
The package includes optimized ArcadeDB JARs. Some components are excluded for size optimization - see `jar_exclusions.txt` for details.
136136

137137
!!! note "Versioning"
138138
Versions are automatically extracted from the main ArcadeDB `pom.xml`. See [versioning strategy](https://humemai.github.io/arcadedb-embedded-python/latest/development/release/#python-versioning-strategy) for details on development vs release mode handling.

bindings/python/build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ print_usage() {
4848
echo ""
4949
echo "Package features:"
5050
echo " ✅ Bundled platform-specific JRE (no Java required)"
51-
echo "All ArcadeDB features except gRPC wire protocol"
51+
echo "Optimized JAR selection (see jar_exclusions.txt)"
5252
echo " ✅ Multi-platform support (5 platforms)"
5353
echo " 📦 Size: ~160MB (JRE ~63MB, JARs ~13MB, overhead ~84MB)"
5454
echo ""

bindings/python/docs/development/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ arcadedb/bindings/python/
139139

140140
1. Extracts ArcadeDB version from parent `pom.xml`
141141
2. Downloads appropriate JAR files with custom filtering
142-
3. Packages Python code with optimized JARs (excludes only gRPC)
142+
3. Packages Python code with optimized JARs (see `jar_exclusions.txt`)
143143
4. Runs tests in isolated Docker environment
144144
5. Creates wheel file in `dist/`
145145

bindings/python/docs/development/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ pip uninstall -y arcadedb-embedded arcadedb-embedded-headless arcadedb-embedded-
5151

5252
Then install the current package:
5353
```bash
54-
# Current package (~123MB, includes all features except gRPC)
54+
# Current package (~123MB with optimized JARs, see jar_exclusions.txt)
5555
pip install arcadedb-embedded
5656
```
5757

bindings/python/docs/getting-started/distributions.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,9 @@ All platforms include a platform-specific bundled JRE - no external Java require
5050
-**Vector Search**: HNSW indexing for embeddings
5151
-**Data Import**: CSV, JSON, Neo4j importers
5252

53-
**Not Included:**
53+
**Optimized:**
5454

55-
-**gRPC Wire Protocol**: Excluded to keep package size manageable
56-
57-
We don't need gRPC at this moment, and we might add it in future versions if needed.
55+
- Some components are excluded to keep package size manageable (see `jar_exclusions.txt` for details)
5856

5957
## Test Results
6058

@@ -64,9 +62,7 @@ We don't need gRPC at this moment, and we might add it in future versions if nee
6462
- ✅ SQL, Cypher, and Gremlin queries work
6563
- ✅ HTTP server and Studio UI work
6664
- ✅ Vector search and import operations work
67-
- ✅ All features available except gRPC
68-
69-
## Use Cases
65+
- ✅ All included features validated
7066

7167
## Use Cases
7268

@@ -119,7 +115,7 @@ Total package size: **162MB wheel (~240MB installed)**
119115
- **Compressed wheel**: 162 MB
120116
- **Installed size**: ~240 MB
121117

122-
**Note**: gRPC wire protocol is excluded to keep package size manageable.
118+
**Note**: Some components are excluded to optimize package size (see `jar_exclusions.txt` for details).
123119

124120
## Installation Tips
125121

bindings/python/setup_jars.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ def find_jar_files():
8383
print(f" Excluded: {len(excluded_jars)}")
8484

8585
if excluded_jars:
86-
print("\n❌ Excluded JARs (gRPC protocol not needed):")
86+
print("\n❌ Excluded JARs:")
8787
for jar in excluded_jars:
8888
jar_name = Path(jar).name
8989
size_mb = Path(jar).stat().st_size / 1024 / 1024

0 commit comments

Comments
 (0)