Skip to main content

A CLI and Python library to interact with Azulene Opal

Project description

opal-cli

Examples of CLI Usage

opal signup --email user@example.com --password secret123
opal login --email user@example.com --password secret123
opal whoami
opal logout

# Jobs
opal jobs submit --job-type xtb_calculation --input-data '{"numbers":[1,1], "positions":[[0,0,0],[0.74,0,0]]}'
opal jobs cancel --job-id abc123
opal jobs get --job-id abc123
opal jobs list-all
opal jobs poll
opal jobs get-job-types
opal jobs get-job-types2
opal jobs health

Examples of Library Usage

from opal import auth, jobs

auth.login(email="test@example.com", password="password123")
jobs.submit_job("generate_conformers", {"smiles": "CCO", "num_conformers": 5})

Install locally:

pip install -e .
where opal
pip show opal-cli

Run locally:

python -m opal.main login --email zeed@azulenelabs.com --password password123

CLI Examples

Help Commands

python -m opal.main --help

python -m opal.main jobs --help

python -m opal.main signup --help

python -m opal.main jobs submit --help

Auth Commands

# Sign up a new user
python -m opal.main signup --email your@email.com --password yourpassword

# Log in
python -m opal.main login --email your@email.com --password yourpassword

# Who am I (get current user info)
python -m opal.main whoami

# Log out
python -m opal.main logout

Job Commands

# Submit a job (CMD)
python -m opal.main jobs submit --job-type generate_conformers --input-data "{\"smiles\": \"CCO\", \"num_conformers\": 5}"

# Submit a job (Git Bash / WSL / Linux / macOS)
python -m opal.main jobs submit --job-type generate_conformers --input-data '{"smiles": "CCO", "num_conformers": 5}'

# Submit a job (Powershell)
python -m opal.main jobs submit --job-type generate_conformers --input-data '{\"smiles\": \"CCO\", \"num_conformers\": 5}'

# List all jobs
python -m opal.main jobs list-all

# Get a specific job by ID
python -m opal.main jobs get --job-id YOUR_JOB_ID

# Cancel a job by ID
python -m opal.main jobs cancel --job-id YOUR_JOB_ID

# Poll modal for job status/results
python -m opal.main jobs poll

# Health check
python -m opal.main jobs health

# Get available job types (from Supabase Storage)
python -m opal.main jobs get-job-types

# Get available job types (from function variable)
python -m opal.main jobs get-job-types2

Tips

  • Wrap JSON input in single quotes ('{"key": "value"}') and escape double quotes on Windows if needed.
  • Replace YOUR_JOB_ID with actual returned IDs from list-all or submit.

How to deploy to PyPI (TestPyPI)

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

azulene_opal-0.1.0.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

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

azulene_opal-0.1.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file azulene_opal-0.1.0.tar.gz.

File metadata

  • Download URL: azulene_opal-0.1.0.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for azulene_opal-0.1.0.tar.gz
Algorithm Hash digest
SHA256 534ab9b72954a353cb0b1779575e0bb1294e22b45a89c63bd8ce02764b227641
MD5 52846c4b5c4d19f26c73fd1886749044
BLAKE2b-256 a2df2c23f864e0a2352aff9bb7735de5b6c4324e7de7aeaa6a0799d877bc0bc3

See more details on using hashes here.

File details

Details for the file azulene_opal-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: azulene_opal-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for azulene_opal-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d61ef5a3b571c40dbaa6ae80aedf73730c4ea22a12844a4f5b4bf9572e7da0b4
MD5 1246c5579c8923cd61da5d0661846d44
BLAKE2b-256 4239687016f5969d519651506a81ae9d539546335cfcca09c9ee86500fd2753e

See more details on using hashes here.

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