Package: pyqalx
pyqalxInterfaces to qalx. For more details, seeproject documentation,.development statuspyqalxis currently under active development. It is pre-version 1.0 beta software and so each minor version
can introduce breaking changes.qalx(an abbreviation of “queued calculations” and pronounced “kal-x”) is a flexible data management platform for engineering projects. Users store data and files in qalx and it provides tools for passing that data between various systems for processing.There will eventually be four ways to interact with the platform:A Python interface (pyqalx)REST API (api.qalx.net)Web console (console.qalx.net) - coming soonA command line interface (qalx-cli) - coming soonMost users are expected to use the web console and either the python or
command line interfaces. The REST API is intended to be used if you
prefer to access the platform with a language other than Python or want
to create a custom interface.Installingqalxis written inPythonand can be
installed via the Python Package Index (PyPi) with:pipinstallpyqalxIf installation has completed properly you should be able to importpyqalxin a python console:>>> import pyqalxWarningpyqalx requiresPython versions above 3.6.Configuration and AuthenticationEverything you do withqalxrequires you to be authenticated. That
is, the platform requires you to identify yourself and will record all
your actions as being performed by you.The way thatqalxknows who you are is by reading aTOKENwhich must be sent with every request.WarningDuring this beta phase, you have to request aTOKENby registering your interest atqalx.netThe easiest way to make sure that your token is sent with every request is to make sure you have a valid.qalxfile
saved in your HOME directory.where isHOME?TheHOMEdirectory can usually be found by putting %USERPROFILE%
in the address bar in Windows Explorer or it is simply~on unix
systems.qalx CLI configureYou can either add theTOKENmanually to the config file or you can use theqalxcli to do this for you automatically$qalxconfigureThe above command will ask you all the necessary questions to create your user and bot config files.You can also create other profiles using theqalx configurecommand. You can even create profiles just for bots
or just for users - or provide extra arguments to write to the config# Will write a user profile called `dev` to the config file,
# will also write a `default` bot config profile$qalx--user-profiledevconfigure# Will write a bot profile called `dev` to the config file,
# will also write a `default` user config profile$qalx--bot-profiledevconfigure# Will not write the bot profile$qalxconfigure--no-bot# Will not write the user profile$qalxconfigure--no-user# Will write a default user and bot profile and will also write two
# extra keys to each config - `CUSTOMKEY=customvalue`
# and `CUSTOMKEY2=customvalue2`$qalxconfigurecustomkey=customvaluecustomkey2=customvalue2Manual configurationIf you don’t want to use theqalx clito configure your profile (or if you want to make changes to it in the future)
then you can configure the profile yourself by adding theTOKENto your config file under
the default profile.[default]TOKEN=632gd7yb9squd0q8sdhq0s8diqsd0nqsdq9sdkAny other configuration settings can be stored in the same file seeconfigurationfor more information.QuickstartThe best place to get started:https://docs.qalx.net/quickstart