Skip to main content

socaity-cli

The command line for the socaity.ai platform: login, catalog browsing, SDK installs, and APIPod deployment tooling. One socaity command, shared by the socaity SDK and APIPod.

The package is deliberately small: httpx and socaity-schemas are the only dependencies. Commands that need more (stub generation, container builds) delegate to the socaity or apipod package and tell you what to install when it is missing.

Install

pip install socaity-cli

You get socaity-cli as part of pip install socaity or pip install apipod as well.

Commands

Command Needs What it does
socaity login / logout / whoami - Browser login, credentials in ~/.config/socaity/
socaity list services|models - Browse the AI catalog
socaity search "flux schnel" - Typo-tolerant search (--collections services,models,jobs)
socaity jobs [job_id] login List/search jobs; --q, --expand data,files,billing,social, --visibility
socaity projects [project_id] login Your projects; --expand jobs embeds member jobs
socaity install <service> socaity Generate an SDK stub for a service
socaity update socaity Sync installed services with the platform
socaity scan apipod Scan a project and generate apipod.json
socaity build [file] apipod Build the deployment container
socaity start [entrypoint] apipod Run an APIPod service locally
socaity deploy [target] apipod Deploy to Socaity (wraps apipod deploy)

Use -C DIR with scan/build/start/deploy to point at a service project directory (e.g. socaity -C simple_test_service deploy serverless-runpod --yes).

Configuration

Env var Default Purpose
SOCAITY_API_KEY from login API key (wins over stored credentials)
SOCAITY_BACKEND_URL https://webapi.socaity.ai Platform API
SOCAITY_FRONTEND_URL https://socaity.ai Web UI for browser login

Using it as a library

socaity and apipod build on the same primitives this package exposes:

from socaity_cli import SocaityBackendClient, get_api_key, requires

SocaityBackendClient covers catalog reads, search, and SDK install/update calls. requires("apipod") guards a function behind an optional package with a friendly install hint instead of an ImportError traceback.

Metadata

Release files for socaity-cli 0.1.3

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

Source distribution (sdist)

Source distribution for socaity-cli 0.1.3
File Size Uploaded
socaity_cli-0.1.3.tar.gz 25.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for socaity-cli 0.1.3
File Interpreter ABI Platform
socaity_cli-0.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 54.3 kB

Release files / socaity_cli-0.1.3.tar.gz

Download URL socaity_cli-0.1.3.tar.gz
Size 25.2 kB
Tags Source
SHA-256 checksum
How to use checksums
bb1b761428d9866fee8ec3a4490f529a1e4254105243ff8dea1db4fb9d3d7867
BLAKE2b-256 checksum
How to use checksums
1de49540decc92cac621ab3a1d5defc76d630f089f9b756c1f61ab82e94fec34
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

Release files / socaity_cli-0.1.3-py3-none-any.whl

Download URL socaity_cli-0.1.3-py3-none-any.whl
Size 29.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3c93c8cebab71ae0fc7520a970249b14398ed31afe1957bdb7491ecd08f1a618
BLAKE2b-256 checksum
How to use checksums
18dfae5ebd430049cc6a070361b3ecb8d7d904b0f1145c5acf91fdd19580f6ab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

Release history Release notifications | RSS feed

0.1.14

2 release files

0.1.13

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

This release

0.1.3 This release

2 release files

0.1.2

2 release files

0.1.1

2 release files

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