Skip to content

Commit 45dd051

Browse files
tae898tae898
committed
Refactor documentation and tests for ArcadeDB Python bindings
- Updated various documentation files to improve clarity and remove redundant information. - Added new test documentation for vector parameters verification. - Enhanced existing test documentation for transaction configuration, type conversion, and vector SQL. - Removed deprecated Gremlin tests and updated links to the new documentation site. - Adjusted package metadata for size and installation details. - Improved troubleshooting steps and examples in the documentation. - Ensured consistency in test counts and descriptions across README files.
1 parent 50c42a0 commit 45dd051

48 files changed

Lines changed: 569 additions & 1358 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/deploy-python-docs.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ name: Deploy MkDocs to GitHub Pages
22

33
on:
44
# Deploy docs when a version tag is pushed (e.g., 25.10.1, 25.10.1.post0)
5-
# Skip .devN versions (e.g., 25.10.1.dev0)
65
push:
76
tags:
87
- '[0-9]+.[0-9]+.[0-9]+*'

‎.github/workflows/release-python-packages.yml‎

Lines changed: 0 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -202,121 +202,3 @@ jobs:
202202
203203
- name: Publish to PyPI
204204
uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # release/v1
205-
206-
github-release:
207-
name: Create GitHub Release (All enabled platforms)
208-
needs: [validate-version, test, test-examples]
209-
runs-on: ubuntu-latest
210-
if: false
211-
permissions:
212-
contents: write
213-
steps:
214-
- name: Download all wheels (all enabled platforms)
215-
uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
216-
with:
217-
pattern: wheel-*-py*
218-
path: dist/
219-
merge-multiple: true
220-
221-
- name: Create GitHub Release
222-
uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191 # v2.0.8
223-
with:
224-
files: dist/*.whl
225-
generate_release_notes: true
226-
draft: false
227-
prerelease: ${{ contains(github.ref_name, 'dev') || contains(github.ref_name, 'rc') || contains(github.ref_name, 'alpha') || contains(github.ref_name, 'beta') }}
228-
body: |
229-
## 🎮 ArcadeDB Embedded Python Bindings v${{ needs.validate-version.outputs.python-version }}
230-
231-
### 📦 Installation
232-
233-
**Recommended (PyPI):**
234-
```bash
235-
uv pip install arcadedb-embedded==${{ needs.validate-version.outputs.python-version }}
236-
```
237-
238-
### 🌍 Supported Platforms
239-
240-
**Available on PyPI**:
241-
- ✅ **Linux x86_64** (servers, CI/CD, Docker, cloud)
242-
- ✅ **Linux ARM64** (Raspberry Pi, AWS Graviton)
243-
- ✅ **macOS Apple Silicon** (M1/M2/M3/M4)
244-
245-
### 📚 Links
246-
- [PyPI Package](https://pypi.org/project/arcadedb-embedded/${{ needs.validate-version.outputs.python-version }}/)
247-
- [Documentation](https://github.com/${{ github.repository }})
248-
- [Examples](https://github.com/${{ github.repository }}/tree/main/bindings/python/examples)
249-
250-
### 🔽 Direct Downloads
251-
All available wheels are attached below. Most users should install via uv (auto-selects correct wheel).
252-
253-
---
254-
**Based on ArcadeDB v${{ needs.validate-version.outputs.base-version }}**
255-
256-
update-pypi-index:
257-
name: Update PyPI simple index on GitHub Pages (All 6 platforms)
258-
needs: [validate-version, github-release]
259-
runs-on: ubuntu-latest
260-
if: false
261-
permissions:
262-
contents: write
263-
env:
264-
GH_TOKEN: ${{ github.token }}
265-
steps:
266-
- name: Checkout gh-pages branch
267-
uses: actions/checkout@v4
268-
with:
269-
ref: gh-pages
270-
271-
- name: Generate PyPI simple index
272-
shell: bash
273-
env:
274-
VERSION: ${{ needs.validate-version.outputs.python-version }}
275-
REPO: ${{ github.repository }}
276-
run: |
277-
# Create simple index directory structure
278-
mkdir -p simple/arcadedb-embedded
279-
280-
# Generate index.html header
281-
cat > simple/arcadedb-embedded/index.html <<'EOF'
282-
<!DOCTYPE html>
283-
<html>
284-
<head>
285-
<title>Links for arcadedb-embedded</title>
286-
<meta name="pypi:repository-version" content="1.0">
287-
</head>
288-
<body>
289-
<h1>Links for arcadedb-embedded</h1>
290-
<p><strong>Alternative PyPI index with all 6 platforms</strong> (official PyPI only has 3 main platforms)</p>
291-
<p>Usage: <code>uv pip install --extra-index-url https://humemai.github.io/arcadedb-embedded-python/simple arcadedb-embedded</code></p>
292-
<p><em>Note: Intel Mac users can use the Apple Silicon wheel via Rosetta 2, or download the native Intel wheel for best performance.</em></p>
293-
<hr/>
294-
EOF
295-
296-
# Get all releases and add wheel links (all 6 platforms from GitHub)
297-
echo "📋 Fetching all releases..."
298-
gh release list --limit 100 --json tagName | jq -r '.[].tagName' | while read -r tag; do
299-
echo " Processing release: $tag"
300-
# Get wheel assets for this release
301-
gh release view "$tag" --json assets --jq '.assets[] | select(.name | endswith(".whl")) | .name' | while read -r wheel; do
302-
echo "<a href=\"https://github.com/${{ github.repository }}/releases/download/$tag/$wheel\">$wheel</a><br/>" >> simple/arcadedb-embedded/index.html
303-
done
304-
done
305-
306-
# Close HTML
307-
cat >> simple/arcadedb-embedded/index.html <<'EOF'
308-
</body>
309-
</html>
310-
EOF
311-
312-
echo "✅ Generated PyPI simple index:"
313-
cat simple/arcadedb-embedded/index.html
314-
315-
- name: Commit and push index
316-
shell: bash
317-
run: |
318-
git config user.name "github-actions[bot]"
319-
git config user.email "github-actions[bot]@users.noreply.github.com"
320-
git add simple/
321-
git commit -m "Update PyPI simple index for v${{ needs.validate-version.outputs.python-version }}" || echo "No changes to commit"
322-
git push

‎.github/workflows/test-python-examples.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ on:
2525
description: "Glob pattern(s) for examples to run (space-separated, relative to bindings/python/examples)."
2626
required: false
2727
type: string
28-
default: "01_*.py"
28+
default: "0[1-7]_*.py"
2929
build-version:
3030
description: "Override package version (PEP 440) for build.sh"
3131
required: false
@@ -37,10 +37,10 @@ on:
3737
examples:
3838
description: "Glob pattern(s) for examples to run (space-separated, relative to bindings/python/examples)."
3939
required: false
40-
default: "01_*.py"
40+
default: "0[1-7]_*.py"
4141

4242
env:
43-
EXAMPLES: ${{ inputs.examples || '01_*.py' }}
43+
EXAMPLES: ${{ inputs.examples || '0[1-7]_*.py' }}
4444

4545
permissions:
4646
contents: read

0 commit comments

Comments
 (0)