Skip to main content

AivudaOS packaged for pip installation and PyPI publishing.

Project description

AivudaOS

aivudaOS is a lightweight OS on swarm robot's onboard computer. It offers a graphical panel which allows you to interact with the onboard system and manage the APPs.

Install

  • Install from PyPI:
pip install aivudaos
# pip install -i https://pypi.tuna.tsinghua.edu.cn/simple aivudaos  # use pypi mirror (may not be the latest)
# pip install aivudaos==1.0.0.dev2026040602  # for a certain version
  • Install from a provided wheel:
pip install aivudaos-1.0.0.dev2026040501-py3-none-any.whl
  • Install from source:
git clone https://gitee.com/buaa_iooda/aivudaOS.git
cd aivudaOS/
pip install -e . # need dated npm and node (>20) installed
# pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -e .  # use pypi mirror for build

To upgrade:

# pip index versions aivudaos --pre  # inspect available versions on PyPI
pip install aivudaos --upgrade

To uninstall:

# stop and remove the systemd service by 'aivudaos uninstall' first:
aivudaos uninstall
pip uninstall aivudaos

Usage

Add python local path first:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

After install the wheel, you need to install aivudaOS dependencies first:

aivudaos install

This will install all the dependencies and start aivudaOS and make aivudaOS autostart.

Then get url and open it in your browser:

aivudaos web
# or
aivudaos status

It will remind you to visit http://127.0.0.1:80 on the local browser, or vist https://<avahi_hostname>.local:443 on a remote browser

The following port is used by aivudaOS:

  • 127.0.0.1:8000: internal backend, reverse proxy by caddy;
  • http://127.0.0.1:80: expose the service by caddy for http;
  • https://<avahi_hostname>.local:443 expose the service by caddy for https,

where the <avahi_hostname> can be read by

aivudaos get-avahi-hostname
aivudaos get-avahi-hostname --debug

Each robot has a randomly generated and unique avahi_hostname on install, which can also be changed in the system setting of the aivudaOS panel.

After installation, you can use the unified CLI:

aivudaos --help
aivudaos --version
aivudaos install
aivudaos web
aivudaos status
aivudaos start
aivudaos stop
aivudaos restart
aivudaos enable-autostart
aivudaos disable-autostart
aivudaos download-caddy
aivudaos uninstall

Build wheel

Build release artifacts locally:

Wheel artifacts include only aivudaos/resources/ui/dist for the frontend. The source distribution excludes dist and node_modules, while keeping the UI source files for development and rebuilding.

cd aivudaOS/
cd aivudaos/resources/ui/ && npm install && npm run build && cd ../../..
AIVUDAOS_BUILD_SEQ=01 
python -m build
# PIP_INDEX_URL=https://pypi.tuna.tsinghua.edu.cn/simple python -m build  # use pypi mirror

If your environment does not provide python -m build isolation support, use:

AIVUDAOS_BUILD_SEQ=01 python -m build --no-isolation

Upload to PyPi:

cd aivudaOS
AIVUDAOS_BUILD_SEQ=01 \
TWINE_USERNAME=__token__ \
TWINE_PASSWORD="$PYPI_TOKEN" \
TWINE_NON_INTERACTIVE=1 \
./publish_aivudaos_pypi.sh

## or not upload
cd aivudaOS
AIVUDAOS_BUILD_SEQ=01 \
./publish_aivudaos_pypi.sh --skip-upload

The automated workflow is activated at https://github.com/shupx/aivudaOS/actions/workflows/nightly-build.yml, which deploys a check every night and build and publish wheels to PyPi if there is a update.

Develop

Refer to README_dev.md

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aivudaos-1.0.0.dev2026041218.tar.gz (190.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aivudaos-1.0.0.dev2026041218-py3-none-any.whl (232.4 kB view details)

Uploaded Python 3

File details

Details for the file aivudaos-1.0.0.dev2026041218.tar.gz.

File metadata

  • Download URL: aivudaos-1.0.0.dev2026041218.tar.gz
  • Upload date:
  • Size: 190.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aivudaos-1.0.0.dev2026041218.tar.gz
Algorithm Hash digest
SHA256 3d771608adfe8357c6ac4d3f053b407aa85ff9faf75c84c01f47c011e31414aa
MD5 ab74dabbf6434d46386a464fe37e545e
BLAKE2b-256 c39974197baef00a3e0623ae56cc73e78eaea72be1799d1d126ce240bf178d95

See more details on using hashes here.

Provenance

The following attestation bundles were made for aivudaos-1.0.0.dev2026041218.tar.gz:

Publisher: nightly-build.yml on shupx/aivudaOS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aivudaos-1.0.0.dev2026041218-py3-none-any.whl.

File metadata

File hashes

Hashes for aivudaos-1.0.0.dev2026041218-py3-none-any.whl
Algorithm Hash digest
SHA256 47c14337c69b3004dbef63d021042c52125ca7862d7b74293d2fb4906c5fe5a1
MD5 088e07f1839b93c45ce919250cf3cf07
BLAKE2b-256 760fb362640236a153d8ce5bccf60f32ed06f1b71b3d17cb580e90b23ab4619f

See more details on using hashes here.

Provenance

The following attestation bundles were made for aivudaos-1.0.0.dev2026041218-py3-none-any.whl:

Publisher: nightly-build.yml on shupx/aivudaOS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page