# 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/94/f5/dbf52a556547fba7bddf67dd810d1dddc63f7ccfcf81e47ee668740c2564/stashapp-tools-0.2.42.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.42",
"project_urls": {
"Homepage": "https://github.com/stg-annon/stashapp-tools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0715a1c732b4bfec838416f421d60ac9c0b5d10dc39ee1ab3865264bf172456b",
"md5": "8a7489ea3f022b30d30b4a6023f82bab",
"sha256": "eb4b2a6590e65f054b1efe8e36a87a9cd8a7a2943b30c193147432c98d918bc0"
},
"downloads": -1,
"filename": "stashapp_tools-0.2.42-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8a7489ea3f022b30d30b4a6023f82bab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 32154,
"upload_time": "2024-03-19T23:48:27",
"upload_time_iso_8601": "2024-03-19T23:48:27.624915Z",
"url": "https://files.pythonhosted.org/packages/07/15/a1c732b4bfec838416f421d60ac9c0b5d10dc39ee1ab3865264bf172456b/stashapp_tools-0.2.42-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "94f5dbf52a556547fba7bddf67dd810d1dddc63f7ccfcf81e47ee668740c2564",
"md5": "1336afd253f1de5ca06cd4b9f2530b98",
"sha256": "b8d57d710df13157ae7f41d8146b546733868d9092cd0710919950e1b42ad79a"
},
"downloads": -1,
"filename": "stashapp-tools-0.2.42.tar.gz",
"has_sig": false,
"md5_digest": "1336afd253f1de5ca06cd4b9f2530b98",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30377,
"upload_time": "2024-03-19T23:48:30",
"upload_time_iso_8601": "2024-03-19T23:48:30.348428Z",
"url": "https://files.pythonhosted.org/packages/94/f5/dbf52a556547fba7bddf67dd810d1dddc63f7ccfcf81e47ee668740c2564/stashapp-tools-0.2.42.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 23:48:30",
"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"
}