Skip to content

Commit bf943da

Browse files
committed
chore: update package size references and simplify installation instructions
1 parent 5ecc0e2 commit bf943da

10 files changed

Lines changed: 58 additions & 101 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ jobs:
364364
echo "" >> $GITHUB_STEP_SUMMARY
365365
echo "The arcadedb-embedded package has been successfully built and tested." >> $GITHUB_STEP_SUMMARY
366366
echo "" >> $GITHUB_STEP_SUMMARY
367-
echo "**Package**: arcadedb-embedded (~160MB with bundled JRE)" >> $GITHUB_STEP_SUMMARY
367+
echo "**Package**: arcadedb-embedded" >> $GITHUB_STEP_SUMMARY
368368
else
369369
echo "❌ **Some platforms failed testing**" >> $GITHUB_STEP_SUMMARY
370370
echo "" >> $GITHUB_STEP_SUMMARY

README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,9 @@
1717
### Installation
1818

1919
```bash
20-
# Temporarily install from GitHub Pages (awaiting PyPI size limit approval)
21-
pip install arcadedb-embedded \
22-
--index-url https://humemai.github.io/arcadedb-embedded-python/simple/ \
23-
--extra-index-url https://pypi.org/simple/
24-
25-
# Once PyPI approves our size limit request, installation will be simpler:
26-
# pip install arcadedb-embedded
20+
pip install arcadedb-embedded
2721
```
2822

29-
> **Note:** We're temporarily using GitHub Pages while awaiting PyPI size limit approval (~160MB wheels, default limit 100MB). The `--extra-index-url` ensures dependencies like JPype1 are installed from PyPI.
30-
3123
**Requirements:**
3224

3325
- **Python 3.8+** only - No Java installation required! (JRE is bundled)

bindings/python/README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,9 @@ Quick links:
2525
### Installation
2626

2727
```bash
28-
# Temporarily install from GitHub Pages (awaiting PyPI size limit approval)
29-
pip install arcadedb-embedded \
30-
--index-url https://humemai.github.io/arcadedb-embedded-python/simple/ \
31-
--extra-index-url https://pypi.org/simple/
32-
33-
# Once PyPI approves our size limit request, installation will be simpler:
34-
# pip install arcadedb-embedded
35-
36-
# Development version (latest features, may be unstable)
37-
pip install --pre arcadedb-embedded \
38-
--index-url https://humemai.github.io/arcadedb-embedded-python/simple/ \
39-
--extra-index-url https://pypi.org/simple/
28+
pip install arcadedb-embedded
4029
```
4130

42-
!!! note "PyPI Size Limit"
43-
We're temporarily hosting wheels on GitHub Pages while awaiting PyPI size limit approval (our wheels are ~164MB, default limit is 100MB). The `--index-url` tells pip to use our GitHub Pages index for arcadedb-embedded, while `--extra-index-url` ensures dependencies like JPype1 are installed from PyPI.
44-
4531
**Requirements:**
4632

4733
- **Python 3.8+ only** - No Java installation required!

bindings/python/build.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ print_header() {
2525
print_usage() {
2626
echo "Usage: $0 [PLATFORM]"
2727
echo ""
28-
echo "Builds arcadedb-embedded package with bundled JRE (~160MB)"
28+
echo "Builds arcadedb-embedded package with bundled JRE"
2929
echo "No external Java installation required!"
3030
echo ""
3131
echo "PLATFORM:"
@@ -52,7 +52,7 @@ print_usage() {
5252
echo " ✅ Bundled platform-specific JRE (no Java required)"
5353
echo " ✅ Optimized JAR selection (see jar_exclusions.txt)"
5454
echo " ✅ Multi-platform support (6 platforms)"
55-
echo " 📦 Size: ~160MB (JRE ~63MB, JARs ~13MB, overhead ~84MB)"
55+
echo " 📦 Size: ~215MB (compressed), ~289MB (installed)"
5656
echo ""
5757
}
5858

bindings/python/docs/development/build-architecture.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,24 @@ This document describes the build architecture for creating platform-specific Py
66

77
**Goal:** Distribute a single `arcadedb-embedded` package that works on 6 platforms with **zero Java installation required**.
88

9-
**Achievement:** 6 platform-specific wheels (~155-161MB each) with bundled platform-specific JRE, built and tested on GitHub Actions using native runners.
9+
**Achievement:** 6 platform-specific wheels (~215MB each) with bundled platform-specific JRE, built and tested on GitHub Actions using native runners.
1010

1111
## Supported Platforms
1212

1313
| Platform | Wheel Size | JRE Size | Runner | Build Method | Notes |
1414
|----------|-----------|----------|---------|--------------|-------|
15-
| **linux/amd64** | 160.9M | 62.7M | `ubuntu-24.04` | Docker native | Most common Linux platform |
16-
| **linux/arm64** | 159.9M | 61.8M | `ubuntu-24.04-arm` | Docker native | ARM64 servers, Raspberry Pi |
17-
| **darwin/amd64** | 157.8M | 55.3M | `macos-15-intel` | Native build | Intel Macs (2006-2020) |
18-
| **darwin/arm64** | 156.7M | 53.9M | `macos-15` | Native build | Apple Silicon Macs (2020+) |
19-
| **windows/amd64** | 157.4M | 51.5M | `windows-2025` | Native build | 64-bit Windows |
20-
| **windows/arm64** | 155.1M | 47.3M | `windows-11-arm` | Native build | ARM64 Windows (Surface, etc.) |
15+
| **linux/amd64** | 215.0M | 62.7M | `ubuntu-24.04` | Docker native | Most common Linux platform |
16+
| **linux/arm64** | 214.1M | 61.8M | `ubuntu-24.04-arm` | Docker native | ARM64 servers, Raspberry Pi |
17+
| **darwin/amd64** | 211.9M | 55.3M | `macos-15-intel` | Native build | Intel Macs (2006-2020) |
18+
| **darwin/arm64** | 210.8M | 53.9M | `macos-15` | Native build | Apple Silicon Macs (2020+) |
19+
| **windows/amd64** | 211.6M | 51.6M | `windows-2025` | Native build | 64-bit Windows |
20+
| **windows/arm64** | 209.4M | 47.6M | `windows-11-arm` | Native build | ARM64 Windows (Surface, etc.) |
2121

2222
**All platforms:**
2323

2424
- ✅ 205/205 tests passing
25-
-167.4M JARs (83 files, identical across platforms)
25+
-226.0M JARs (83 files, identical across platforms)
2626
- ✅ All native runners (no QEMU emulation)
27-
-~40MB savings vs initial builds (195.9M → 155-161M)
2827
- ✅ Reproducible builds (pinned runner versions)
2928

3029
## Architecture
@@ -379,22 +378,22 @@ bindings/python/
379378
- Python package: ~5M
380379
- **Total:** 195.9M wheel
381380
382-
### After Optimization (157-160M)
381+
### After Optimization (215M)
383382
384-
- ArcadeDB JARs: 167.4M (83 files, gRPC excluded)
383+
- ArcadeDB JARs: 226.0M (83 files, gRPC excluded)
385384
- Bundled JRE: ~63M
386385
- Python package: ~5M
387-
- **Total:** 157-160M wheel
388-
- **Savings:** ~40MB per wheel
386+
- **Total:** ~215M wheel (compressed)
387+
- **Installed:** ~289M (uncompressed)
389388
390389
### Why Sizes Vary by Platform
391390
392391
- JRE binaries differ by platform (different native code)
393-
- darwin/amd64: 157.8M (Intel Mac JRE)
394-
- darwin/arm64: 156.7M (Apple Silicon JRE, more efficient)
395-
- windows/amd64: 157.4M (Windows JRE)
396-
- linux/amd64: 160.9M (Linux x64 JRE)
397-
- linux/arm64: 159.9M (Linux ARM64 JRE)
392+
- darwin/amd64: ~215M (Intel Mac JRE)
393+
- darwin/arm64: ~215M (Apple Silicon JRE)
394+
- windows/amd64: ~215M (Windows JRE)
395+
- linux/amd64: ~215M (Linux x64 JRE)
396+
- linux/arm64: ~215M (Linux ARM64 JRE)
398397
399398
## Development
400399

bindings/python/docs/development/ci-setup.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -102,29 +102,29 @@ You need to create one environment in GitHub repository settings:
102102
After a successful release, you should see:
103103

104104
- **6 wheel files** on PyPI for `arcadedb-embedded` (one per platform):
105-
- linux/amd64: ~160.9MB wheel
106-
- linux/arm64: ~159.9MB wheel
107-
- darwin/amd64: ~157.8MB wheel
108-
- darwin/arm64: ~156.7MB wheel
109-
- windows/amd64: ~157.4MB wheel
110-
- windows/arm64: ~155.1MB wheel
105+
- linux/amd64: ~215MB wheel
106+
- linux/arm64: ~215MB wheel
107+
- darwin/amd64: ~215MB wheel
108+
- darwin/arm64: ~215MB wheel
109+
- windows/amd64: ~215MB wheel
110+
- windows/arm64: ~215MB wheel
111111

112112
### Test Results (CI run #96)
113113

114114
All 6 platforms passing 205/205 tests:
115115

116116
| Platform | Wheel Size | JRE Size | Tests |
117117
|----------|-----------|----------|-------|
118-
| linux/amd64 | 160.9M | 62.7M | 205/205 ✅ |
119-
| linux/arm64 | 159.9M | 61.8M | 205/205 ✅ |
120-
| darwin/amd64 | 157.8M | 55.3M | 205/205 ✅ |
121-
| darwin/arm64 | 156.7M | 53.9M | 205/205 ✅ |
122-
| windows/amd64 | 157.4M | 51.5M | 205/205 ✅ |
123-
| windows/arm64 | 155.1M | 47.3M | 205/205 ✅ |
118+
| linux/amd64 | ~215M | 62.7M | 205/205 ✅ |
119+
| linux/arm64 | ~215M | 61.8M | 205/205 ✅ |
120+
| darwin/amd64 | ~215M | 55.3M | 205/205 ✅ |
121+
| darwin/arm64 | ~215M | 53.9M | 205/205 ✅ |
122+
| windows/amd64 | ~215M | 51.5M | 205/205 ✅ |
123+
| windows/arm64 | ~215M | 47.3M | 205/205 ✅ |
124124

125125
**All platforms include:**
126126

127-
- 167.4M JARs (83 files, identical across platforms, gRPC excluded)
127+
- 226.0M JARs (83 files, identical across platforms, gRPC excluded)
128128
- Platform-specific JRE (47-63MB depending on platform)
129129
- Native runners (no QEMU emulation anywhere)
130130

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

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,12 @@ ArcadeDB Python provides a **self-contained embedded** package that runs the dat
66

77
| Package | Wheel Size | Installed Size | Java Required | Studio UI | Query Languages |
88
|---------|-----------|----------------|---------------|-----------|----------------|
9-
| **arcadedb-embedded** | 155-161MB | ~215-230MB | ❌ No || SQL, Cypher, Gremlin, MongoDB |
9+
| **arcadedb-embedded** | ~215MB | ~289MB | ❌ No || SQL, Cypher, Gremlin, MongoDB |
1010

1111
**Installation:**
1212

1313
```bash
14-
# Temporarily install from GitHub Pages (awaiting PyPI size limit approval)
15-
pip install arcadedb-embedded \
16-
--index-url https://humemai.github.io/arcadedb-embedded-python/simple/ \
17-
--extra-index-url https://pypi.org/simple/
14+
pip install arcadedb-embedded
1815
```
1916

2017
**Requirements:** Python 3.8+ only - No Java installation needed!
@@ -23,24 +20,24 @@ pip install arcadedb-embedded \
2320

2421
The package includes everything you need:
2522

26-
- **ArcadeDB JARs** (167.4MB): Core database with all features
23+
- **ArcadeDB JARs** (226.0MB): Core database with all features
2724
- **Bundled JRE** (47-63MB): Platform-specific Java 21 runtime (via jlink)
2825
- **Python Package** (~5MB): Python wrapper and utilities
2926

30-
**Total:** 155-161MB compressed wheel (varies by platform), ~215-230MB when installed
27+
**Total:** ~215MB compressed wheel (varies by platform), ~289MB when installed
3128

3229
## Platform Support
3330

3431
Pre-built **platform-specific** wheels are available for **6 platforms**:
3532

3633
| Platform | Wheel Size | JRE Size | Installed Size | Tests |
3734
|----------|-----------|----------|----------------|-------|
38-
| Windows ARM64 | 155.1M | 47.3M | ~215M | 205/205 ✅ |
39-
| macOS ARM64 (Apple Silicon) | 156.7M | 53.9M | ~221M | 205/205 ✅ |
40-
| macOS Intel (x86_64) | 157.8M | 55.3M | ~223M | 205/205 ✅ |
41-
| Windows x64 | 157.4M | 51.5M | ~219M | 205/205 ✅ |
42-
| Linux ARM64 | 159.9M | 61.8M | ~229M | 205/205 ✅ |
43-
| Linux x64 | 160.9M | 62.7M | ~230M | 205/205 ✅ |
35+
| Windows ARM64 | 209.4M | 47.6M | ~274M | 205/205 ✅ |
36+
| macOS ARM64 (Apple Silicon) | 210.8M | 53.9M | ~280M | 205/205 ✅ |
37+
| macOS Intel (x86_64) | 211.9M | 55.3M | ~281M | 205/205 ✅ |
38+
| Windows x64 | 211.6M | 51.6M | ~278M | 205/205 ✅ |
39+
| Linux ARM64 | 214.1M | 61.8M | ~288M | 205/205 ✅ |
40+
| Linux x64 | 215.0M | 62.7M | ~289M | 205/205 ✅ |
4441

4542
**Key Features:**
4643

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

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,9 @@
55
The `arcadedb-embedded` package is **self-contained** with a bundled JRE - **no Java installation required!**
66

77
```bash
8-
# Temporarily install from GitHub Pages (awaiting PyPI size limit approval)
9-
pip install arcadedb-embedded \
10-
--index-url https://humemai.github.io/arcadedb-embedded-python/simple/ \
11-
--extra-index-url https://pypi.org/simple/
8+
pip install arcadedb-embedded
129
```
1310

14-
!!! note "Temporary GitHub Pages Installation"
15-
We're temporarily hosting wheels on GitHub Pages while awaiting PyPI size limit approval (our wheels are ~160MB, default limit is 100MB).
16-
17-
- `--index-url`: Primary index (GitHub Pages for arcadedb-embedded)
18-
- `--extra-index-url`: Secondary index (PyPI for dependencies like JPype1)
19-
20-
Once PyPI approves our size limit request, installation will be simpler:
21-
```bash
22-
pip install arcadedb-embedded
23-
```
24-
2511
**Requirements:**
2612

2713
- **Python 3.8+ only** - No Java installation required!
@@ -32,22 +18,22 @@ pip install arcadedb-embedded \
3218

3319
## What's Included
3420

35-
The `arcadedb-embedded` package (~155-161MB wheel, ~215-230MB installed) includes everything you need:
21+
The `arcadedb-embedded` package (~215MB wheel, ~289MB installed) includes everything you need:
3622

37-
- **ArcadeDB JARs**: 167.4MB (identical across all platforms)
23+
- **ArcadeDB JARs**: 226.0MB (identical across all platforms)
3824
- **Bundled JRE**: 47-63MB (platform-specific Java 21 runtime via jlink)
3925
- **Python Package**: ~5MB
4026

4127
**Platform Details:**
4228

4329
| Platform | Wheel Size | JRE Size | Installed Size |
4430
|----------|-----------|----------|----------------|
45-
| Windows ARM64 | 155.1M | 47.3M | ~215M |
46-
| macOS ARM64 | 156.7M | 53.9M | ~221M |
47-
| macOS Intel | 157.8M | 55.3M | ~223M |
48-
| Windows x64 | 157.4M | 51.5M | ~219M |
49-
| Linux ARM64 | 159.9M | 61.8M | ~229M |
50-
| Linux x64 | 160.9M | 62.7M | ~230M |
31+
| Windows ARM64 | ~215M | 47.3M | ~278M |
32+
| macOS ARM64 | ~215M | 53.9M | ~285M |
33+
| macOS Intel | ~215M | 55.3M | ~286M |
34+
| Windows x64 | ~215M | 51.5M | ~282M |
35+
| Linux ARM64 | ~215M | 61.8M | ~293M |
36+
| Linux x64 | ~215M | 62.7M | ~294M |
5137

5238
**Features Included:**
5339

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,7 @@ Get up and running with ArcadeDB Python bindings in 5 minutes!
77
Install the self-contained package with bundled JRE:
88

99
```bash
10-
# Temporarily install from GitHub Pages (awaiting PyPI size limit approval)
11-
pip install arcadedb-embedded \
12-
--index-url https://humemai.github.io/arcadedb-embedded-python/simple/ \
13-
--extra-index-url https://pypi.org/simple/
10+
pip install arcadedb-embedded
1411
```
1512

1613
!!! note "No Java Installation Required"

bindings/python/docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ We provide a **single, self-contained package** that works on all major platform
138138

139139
| Platform | Package Name | Size | What's Included |
140140
|----------|-------------|------|-----------------|
141-
| **All Platforms** | `arcadedb-embedded` | ~160MB | Full ArcadeDB + Bundled JRE + Studio UI + Gremlin |
141+
| **All Platforms** | `arcadedb-embedded` | ~215MB | Full ArcadeDB + Bundled JRE + Studio UI + Gremlin |
142142

143143
All distributions use the same import:
144144

@@ -179,8 +179,8 @@ import arcadedb_embedded as arcadedb
179179

180180
!!! note "Self-Contained"
181181
Everything needed to run ArcadeDB is included in the wheel.
182-
- **Bundled JRE**: Platform-specific Java 21 runtime (~50-60MB)
183-
- **ArcadeDB JARs**: Core database engine (~160MB)
182+
- **Bundled JRE**: Platform-specific Java 21 runtime (~63MB)
183+
- **ArcadeDB JARs**: Core database engine (~226MB)
184184
- **JPype**: Bridge between Python and the bundled JVM
185185

186186
## Community & Support

0 commit comments

Comments
 (0)