stashapp-tools

Name	stashapp-tools JSON
Version	0.2.57 JSON
	download
home_page	https://github.com/stg-annon/stashapp-tools
Summary	A python library for interfacing with a stashapp's API
upload_time	2025-01-17 17:53:12
maintainer	None
docs_url	None
author	stg-annon
requires_python	None
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # stashapp-tools
This library primarily serves as a API wrapper for [Stash](https://github.com/stashapp/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

## Installation 

##### To install from PyPI use this command:
`pip install stashapp-tools`

##### To install directly from this repo use this command:
`pip install git+https://github.com/stg-annon/stashapp-tools`

## Usage
```python
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



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/stg-annon/stashapp-tools",
    "name": "stashapp-tools",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "stg-annon",
    "author_email": "14135675+stg-annon@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/8b/d9/95ec96f60ac44fc2d4479081e2cd4bc7b5158a58c5682051f7c3247e10f6/stashapp-tools-0.2.57.tar.gz",
    "platform": null,
    "description": "# stashapp-tools\nThis library primarily serves as a API wrapper for [Stash](https://github.com/stashapp/stash) written in python\n\n## Requirements\nDeveloped 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\n\n## Installation \n\n##### To install from PyPI use this command:\n`pip install stashapp-tools`\n\n##### To install directly from this repo use this command:\n`pip install git+https://github.com/stg-annon/stashapp-tools`\n\n## Usage\n```python\nimport stashapi.log as log\nfrom stashapi.stashapp import StashInterface\n\nstash = StashInterface({\n    \"scheme\": \"http\",\n    \"host\":\"localhost\",\n    \"port\": \"9999\",\n    \"logger\": log\n})\n\nscene_data = stash.find_scene(1234)\nlog.info(scene_data)\n```\nThis example creates a connection to Stash query's a scene with ID 1234 and prints the result to Stash's logs\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A python library for interfacing with a stashapp's API",
    "version": "0.2.57",
    "project_urls": {
        "Homepage": "https://github.com/stg-annon/stashapp-tools"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c6ff557c8d7ef6c0faa8af8175d4ea7a46b0f3d017a892b8c87b503cd51ee206",
                "md5": "0618f948e8622552911b7d4f82f7e5ce",
                "sha256": "0d51b70c38de3ce40df0e9795c3fca66245bd5fd7c628959fc96726c39df8544"
            },
            "downloads": -1,
            "filename": "stashapp_tools-0.2.57-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0618f948e8622552911b7d4f82f7e5ce",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 34786,
            "upload_time": "2025-01-17T17:53:11",
            "upload_time_iso_8601": "2025-01-17T17:53:11.307254Z",
            "url": "https://files.pythonhosted.org/packages/c6/ff/557c8d7ef6c0faa8af8175d4ea7a46b0f3d017a892b8c87b503cd51ee206/stashapp_tools-0.2.57-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8bd995ec96f60ac44fc2d4479081e2cd4bc7b5158a58c5682051f7c3247e10f6",
                "md5": "1a310c64399034923246500ae8c47e64",
                "sha256": "d302d6c2f666bafbace5e93290b40b3ec01c99df1aff5dec57584e8fbf09186e"
            },
            "downloads": -1,
            "filename": "stashapp-tools-0.2.57.tar.gz",
            "has_sig": false,
            "md5_digest": "1a310c64399034923246500ae8c47e64",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 32912,
            "upload_time": "2025-01-17T17:53:12",
            "upload_time_iso_8601": "2025-01-17T17:53:12.438861Z",
            "url": "https://files.pythonhosted.org/packages/8b/d9/95ec96f60ac44fc2d4479081e2cd4bc7b5158a58c5682051f7c3247e10f6/stashapp-tools-0.2.57.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-17 17:53:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stg-annon",
    "github_project": "stashapp-tools",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "stashapp-tools"
}