Skip to main content

ShapleyCut service

Project description

ShapleyCut API

Dedicated service for the ShapleyCut compression engine. This package exposes HTTP endpoints for optimizing memory and running the gateway mode.

Core engine: https://pypi.org/project/shapleycut-core/

Install

pip install shapleycut-api

Quickstart

python -m uvicorn shapleycut_api.main:app --host 0.0.0.0 --port 8000

If you are on Python 3.14 and see httptools errors, use:

python -m uvicorn shapleycut_api.main:app --host 0.0.0.0 --port 8000 --http h11

SDK snippet (Python)

from shapleycut import MemoryMessage, optimize_messages

messages = [
	MemoryMessage(role="system", content="You are a helpful assistant."),
	MemoryMessage(role="user", content="Summarize the project status."),
	MemoryMessage(role="assistant", content="We shipped MVP and added gateway mode."),
]

out = optimize_messages(messages, max_output_tokens=512)
print(out.optimized_memory)

Endpoints

  • GET /health
  • POST /v1/optimize
  • POST /v1/chat/completions
  • POST /v1/responses
  • GET /v1/metrics
  • GET /v1/metrics/export

Environment

LLM credentials (server side only):

  • GITHUB_TOKEN or GH_TOKEN
  • GITHUB_INFERENCE_BASE_URL (default: https://models.github.ai/inference)
  • OPENAI_API_KEY
  • OPENAI_BASE_URL (default: https://api.openai.com/v1)

Gateway settings:

  • SHAPLEYCUT_GATEWAY_PROVIDER (github_azure, openai, anthropic)
  • SHAPLEYCUT_GATEWAY_BASE_URL
  • SHAPLEYCUT_GATEWAY_API_KEY_ENV
  • SHAPLEYCUT_GATEWAY_API_KEY
  • SHAPLEYCUT_GATEWAY_REQUIRE_KEY
  • SHAPLEYCUT_GATEWAY_ALLOW_OVERRIDE
  • SHAPLEYCUT_GATEWAY_LOG
  • SHAPLEYCUT_GATEWAY_DB
  • SHAPLEYCUT_GATEWAY_METRICS_MAX
  • SHAPLEYCUT_GATEWAY_CACHE_MAX
  • SHAPLEYCUT_GATEWAY_CACHE_TTL_S

Notes

  • /v1/responses is not supported when SHAPLEYCUT_GATEWAY_PROVIDER=github_azure. Use /v1/chat/completions or set the provider to openai.

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

shapleycut_api-0.2.4.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

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

shapleycut_api-0.2.4-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file shapleycut_api-0.2.4.tar.gz.

File metadata

  • Download URL: shapleycut_api-0.2.4.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for shapleycut_api-0.2.4.tar.gz
Algorithm Hash digest
SHA256 a9d5ea93034f49b4bfeeeea250eadb4b39f46abdb53a4d0cec9010ea7c71b11d
MD5 3fc26aa9e2bbf07384f8538da1bf973c
BLAKE2b-256 877b268b662eb6bd289dd1b4dbdd35d9cf0336b0dbb90ab683395ec9a47644f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for shapleycut_api-0.2.4.tar.gz:

Publisher: publish.yml on iv4n-ga6l/ShapleyCut

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shapleycut_api-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: shapleycut_api-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for shapleycut_api-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c1e49957adfcc4d41e6d375d015738605746a535d461564c4c3f3210688449e6
MD5 cf82c80a95a50e04937228c610509458
BLAKE2b-256 5282805895b2b866e82eeaaba20da4ef2d178b5ddda72f20925bd8f9b2c030e9

See more details on using hashes here.

Provenance

The following attestation bundles were made for shapleycut_api-0.2.4-py3-none-any.whl:

Publisher: publish.yml on iv4n-ga6l/ShapleyCut

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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