User - 0 - Installation

Installation

If you use Fluxon directly, you usually deal with two install bundles:

• Fluxon core artifacts: the unified fluxon_ai-*.whl, pylib_src.tar.gz, install.py, and fluxon_release.sha256
• Runtime packages for etcd / Greptime / TiKV: ext_images.tar.gz

If your Python process only attaches to an existing service plane, you normally only need the Fluxon core package. If you also need to start the KV / MQ / FS service plane yourself, prepare the etcd / Greptime / TiKV runtime package as well. See Architecture and Concepts for the role model.

Install the Python Package from PyPI

If the Python process attaches to an existing service plane, install the fluxon-ai distribution directly from PyPI:

python3 -m pip install fluxon-ai

The distribution name uses a hyphen; the installed Python import path remains:

import fluxon_py

The current PyPI wheel targets Linux x86_64 with a manylinux_2_28 baseline. It does not include the etcd / Greptime / TiKV service-plane runtime; use the complete GitHub Release below when those objects are required.

Download Complete Artifacts from GitHub Releases

https://github.com/<org>/fluxon/releases

Install Fluxon Core

tar xzf fluxon_release.tar.gz
cd fluxon_release
python3 -m pip install fluxon_ai-*.whl

Unpack etcd / Greptime / TiKV

tar xzf ext_images.tar.gz

Expected files:

• ext_images/etcd/etcd
• ext_images/etcd/etcdctl
• ext_images/etcd/start.sh
• ext_images/greptime/greptime
• ext_images/greptime/start.sh
• ext_images/tikv/pd-server
• ext_images/tikv/tikv-server
• ext_images/tikv/start_pd.sh
• ext_images/tikv/start_tikv.sh
• ext_images/ext_images.sha256

Fluxon does not replace these external dependencies from inside fluxon_py.runtime.

Build from Source

The main packaging entrypoint is setup_and_pack/pack_release.py. It automatically calls setup_and_pack/pack_release_ext.py and gathers core wheels, pylib_src.tar.gz, install.py, ext_images.tar.gz, and fluxon_release.sha256 into fluxon_release/.

• setup_and_pack/pack_release.py: package Fluxon core artifacts
• setup_and_pack/pack_release_ext.py: export etcd / Greptime / TiKV runtime objects

Related docs:

• Developer - 1 - Package Core Install Artifacts
• Developer - 2 - Package Middleware and Images

Artifact List

Fluxon Core

File	Description
fluxon_ai-*.whl	Unified Fluxon Python package with the PyO3 runtime embedded
pylib_src.tar.gz	Python source bundle
install.py	Release runtime entrypoint
fluxon_release.sha256	SHA256 checksum file for all release artifacts

etcd / Greptime / TiKV

File	Description
ext_images/etcd/etcd	etcd executable
ext_images/etcd/etcdctl	etcd CLI
ext_images/etcd/start.sh	etcd startup script
ext_images/greptime/greptime	greptime executable
ext_images/greptime/start.sh	greptime startup script
ext_images/tikv/pd-server	TiKV PD executable
ext_images/tikv/tikv-server	TiKV executable
ext_images/tikv/start_pd.sh	TiKV PD startup script
ext_images/tikv/start_tikv.sh	TiKV startup script
ext_images/ext_images.sha256	SHA256 checksum file for runtime artifacts

Verify the Install

python3 -c "import fluxon_py; print('ok')"

If you also unpacked local runtime artifacts, a quick binary check is:

test -x ext_images/etcd/etcd
test -x ext_images/greptime/greptime
test -x ext_images/tikv/pd-server
test -x ext_images/tikv/tikv-server

System Requirements

• Linux only
• Python >= 3.10
• Prebuilt Python wheels currently use the manylinux_2_28 ABI baseline
• When building from source, follow fluxon_rs/rust-toolchain.toml, currently pinned to 1.93.0
• Docker is only required for Quick Start or for running setup_and_pack/pack_release_ext.py