Skip to main content

API wrapper and tools for interfacing with a [Stash](https://github.com/stashapp/stash) instance

Project description

stashapi

This library primarily serves as an API wrapper for Stash written in Python

Requirements

Developed using python 3.11.X with attempts to make things as backwards compatible where possible, if you are having issues please try using python 3.11

Should be fully supported up to and including Python 3.13. Stash currently bundles Python 3.12.7

Installation

To install from PyPI use this command:

pip install stashapi

To install directly from this repo use this command:

pip install git+https://github.com/stg-annon/stashapi

Usage

import stashapi.log as log
from stashapi.stashapp import StashInterface

stash = StashInterface({
    "scheme": "http",
    "host":"localhost",
    "port": "9999",
    "logger": log
})

scene_data = stash.find_scene(1234)
log.info(scene_data)

This example creates a connection to Stash query's a scene with ID 1234 and prints the result to Stash's logs

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

stashapi-0.1.5.tar.gz (66.5 kB view details)

Uploaded Source

Built Distribution

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

stashapi-0.1.5-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file stashapi-0.1.5.tar.gz.

File metadata

  • Download URL: stashapi-0.1.5.tar.gz
  • Upload date:
  • Size: 66.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.1

File hashes

Hashes for stashapi-0.1.5.tar.gz
Algorithm Hash digest
SHA256 c1aeca73c4aecd3191d404d2794f7eb3aa4bf9b563cdf0aa3796bfb3aeb0c2aa
MD5 c48fd3cc6e3570c255c1b39caea45c1d
BLAKE2b-256 4179960a7e610e9260813f08217a5f8d4285bb35c234a1bc8aa0ef73dde3f70f

See more details on using hashes here.

File details

Details for the file stashapi-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: stashapi-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.1

File hashes

Hashes for stashapi-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 73340b56f467ff07f82d1bec7f770ef4e64e2348ce3248dad620ef3f9637be56
MD5 eb430e24731c63f5abc873bf554e5280
BLAKE2b-256 9915e2db9f4425473a21a854caceed2c7430ade64893168d6d395662b45336b4

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