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.4.tar.gz (66.3 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.4-py3-none-any.whl (38.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for stashapi-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f10cb4c74ceb4b1961ecdebe1e2d87f6796d8dc7a3e1d35296a4cf427f267509
MD5 cf652220b19a16e86ddd505e9366cf0d
BLAKE2b-256 eeaa01c4fac802d75527b652cf668e17596ebb8d27f2ad48c064532eaf46be1e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for stashapi-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 62c37affe779c15f41d3a6ca2d6c2a5dd5229abe2dbb462f2ade33223ba17e6c
MD5 38ff76434b5538d270505d1522799b25
BLAKE2b-256 d2ac9fcb99b368c3d05718bb8448ad7ea61447082846ee3e6dad2b100b381d58

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