Installation

Warning

absbox is heavily using match clause which was introduced in Python 3.10. Please make sure you are using Python3.10 and after

User need to complete both part (Green and Blue) to run absbox successfully.

  • Green -> The Python package absbox

  • Blue -> The Engine Hastructure

Installation Overview

Installation Overview

Install absbox

Using pip

pip install absbox

Upgrade absbox package to latest

absbox is evolving rapidly, please make sure you are using the latest one.

pip install -U absbox

Check version

pip show absbox

which shows current version of absbox

version

Warning

Version matters !!

As absbox is calling RESTful service from Hastructure. The message format for both shall be compatible to each other.

i.e absbox 0.8.5 is compatible with Hastructure 0.8.6. A general rule is that the “MINOR” part shall be same. ( here the 8 )

Install Hastructure

absbox needs connecting to an Hastructure engine. User can choose a public one or use it’s own if user is keen on privacy and performance.

User has mulitple options to setup Hastructure, either use public ones or host internally. absbox talks to RESTful interface exposed by Hastructure.

Note

Which type of deployment is suitable for you?

Public Servers

Easy to access, not setup action required. Multiple servers globally with latest dev and stable version. But there is not guarantee on the performance, networking IO and SLA, either messages transmited are not ganrantee to be safe. It is good for testing and learning.

Local binaries/executables

Easy to setup, just download the binary and run it. It doesn’t require Docker installed and it’s has all platform support (Windows/MacOS/Ubuntu).

Docker image

Easy to setup, just pull the image and run it in user’s own enviroment. But user need to have Docker installed. The image can be composed together with other services in user’s own enviroment. It is good for in-house integration.

Local build from source

It’s always good to have a local build, as user can have full control on the engine. But the setup requires some technical knowledge on Haskell. It is good for experts.

user_choose_server

Use Public Server

For public server list, please visit absbox.org

Warning

Public server :

  • may provide less calculation performance

  • suffer high network IO

  • doesn’t ganrantee the SLA.

Please don’t use it in production.

Use Docker

User can pull the image by one-line solution

docker pull yellowbean/hastructure
docker run yellowbean/hastructure
# by default the server expose its port at 8081

Note

Hastructure latest v.s dev

There are two builds in the docker hub.

  • latest -> stable version

  • dev -> most sexy feature included

    # get latest version by default
docker pull yellowbean/hastructure

# get dev version by default
docker pull yellowbean/hastructure:dev

# get latest version by default
docker pull yellowbean/hastructure:latest

Use Pre-build binary

Use pre-built binary from Releases

Note

MacOS/Ubuntu/Windows binaries are supported

  • Just download the exeutables and

  • put Config File in same folder.

  • run the executable

See also

How to use pre-built executable

Connect to a engine

Once user has installed absbox and get Hastructure running ,user just need to pass in a URL points to engine.

from absbox import API
localAPI = API("https://absbox.org/api/latest")

# optinally adding a `english` to request all responces in English
localAPI = API("https://absbox.org/api/latest",'english')

Engine Shortcut

New in version 0.26.7.

Since version 0.26.7, absbox ships with a shortcut to connect public/test engines.

from absbox import API,EnginePath

# https://absbox.org/api/dev
localAPI = API(EnginePath.DEV,check=False)

# https://absbox.org/api/latest
localAPI = API(EnginePath.PROD,check=False)

# http://localhost:8081
localAPI = API(EnginePath.LOCAL,check=False)

Auto Connect Best Fit Engine

The function PickApiFrom will try to connect to the best fit engine from the list of APIs.

If absbox is version 0.28.5, it will find first engine with version 0.28.x and connect to it.

New in version 0.28.5.

from absbox import PickApiFrom

# auto connect to the best fit engine
listOfApis = [EnginePath.PROD,EnginePath.DEV,"http://your_own_server:8081"]

api = PickApiFrom(listOfApis,check=False,lang='english')