Skip to main content

pyqalx

https://img.shields.io/bitbucket/pipelines/agiletekengineering/pyqalx:alt:BitbucketPipelines https://api.codacy.com/project/badge/Grade/fdfb81fd286a474098b624b426d63c41 https://api.codacy.com/project/badge/Coverage/fdfb81fd286a474098b624b426d63c41

Interfaces to qalx. For more details, see project documentation,.

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 soon

  • A command line interface (qalx-cli) - coming soon

Most 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.

Installing

qalx is written in Python and can be installed via the Python Package Index (PyPi) with:

pip install pyqalx

If installation has completed properly you should be able to import pyqalx in a python console:

>>> import pyqalx

Configuration and Authentication

Everything you do with qalx requires 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 that qalx knows who you are is by reading a TOKEN which must be sent with every request.

The easiest way to make sure that your token is sent with every request is to make sure you have a valid .qalx file saved in your HOME directory.

qalx CLI configure

You can either add the TOKEN manually to the config file or you can use the qalx cli to do this for you automatically

$ qalx configure

The above command will ask you all the necessary questions to create your user and bot config files.

You can also create other profiles using the qalx configure command. 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-profile dev configure

# Will write a bot profile called `dev` to the config file,
# will also write a `default` user config profile
$ qalx --bot-profile dev configure

# Will not write the bot profile
$ qalx configure --no-bot

# Will not write the user profile
$ qalx configure --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`
$ qalx configure customkey=customvalue customkey2=customvalue2

Manual configuration

If you don’t want to use the qalx cli to configure your profile (or if you want to make changes to it in the future) then you can configure the profile yourself by adding the TOKEN to your config file under the default profile.

[default]
TOKEN = 632gd7yb9squd0q8sdhq0s8diqsd0nqsdq9sdk

Any other configuration settings can be stored in the same file see configuration for more information.

Quickstart

The best place to get started: https://docs.qalx.net/quickstart

Metadata

Release files for pyqalx 0.19.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyqalx 0.19.2
File Size Uploaded Provenance
pyqalx-0.19.2.tar.gz 120.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pyqalx 0.19.2
File Interpreter ABI Platform
pyqalx-0.19.2-py3-none-any.whl Python 3 none any Details

Total release size: 266.6 kB

Release files / pyqalx-0.19.2.tar.gz

Download URL pyqalx-0.19.2.tar.gz
Size 120.1 kB
Tags Source
SHA-256 checksum
How to use checksums
e91d489100a45e7a19c044718b97a7b20c9ef39d946570c1e593fe2b2b579f82
BLAKE2b-256 checksum
How to use checksums
4493d46df448c972600e534adbdea2aa54ac79edb4412d867631c4b8a43fab14
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.8.18 Linux/5.15.0-1055-aws

Release files / pyqalx-0.19.2-py3-none-any.whl

Download URL pyqalx-0.19.2-py3-none-any.whl
Size 146.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
216010bd4759c90bc27b0f4fe4c823b6e06bcbd11470f273a9d7b56b6992d748
BLAKE2b-256 checksum
How to use checksums
db1ef3e6fbcaeeb3f5f7e8d4fefd47d8a09b26640495f7f121aa6e898594eec8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.8.18 Linux/5.15.0-1055-aws

Security for pyqalx 0.19.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.19.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page