stashapp-cli 0.1.0__py3-none-any.whl

stashapp_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,208 @@
+Metadata-Version: 2.4
+Name: stashapp-cli
+Version: 0.1.0
+Summary: Command-line client for the Stash GraphQL API
+Keywords: stash,graphql,cli
+Author: razputingh
+Author-email: razputingh <331436478+razputingh@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Project-URL: Homepage, https://github.com/razputingh/stashapp-cli
+Project-URL: Documentation, https://github.com/razputingh/stashapp-cli/tree/main/docs
+Project-URL: Repository, https://github.com/razputingh/stashapp-cli
+Project-URL: Issues, https://github.com/razputingh/stashapp-cli/issues
+Description-Content-Type: text/markdown
+
+# stashapp-cli
+
+stashapp-cli is a command-line tool for [Stash](https://github.com/stashapp/stash),
+the self-hosted organizer for your media library. It reads and changes your
+Stash library through the GraphQL API of Stash. Each command prints JSON, so
+you can use stashapp-cli in shell scripts and with tools such as `jq`.
+
+stashapp-cli is not part of the Stash project. The Stash developers do not make
+or support it.
+
+## What it does
+
+- Find, create, and update studios, tags, groups, scenes, and performers.
+- Merge duplicate tags and performers, and delete tags. A dry run first
+  reports what the change will remove.
+- Scrape metadata from stash-boxes and installed scrapers.
+- Start scan, generate, and identify jobs, and wait for them to end.
+- Back up the Stash database, and submit scene fingerprints to a stash-box.
+- Send a GraphQL query or mutation that you write.
+
+A stash-box is a shared database of scene and performer metadata, such as
+StashDB.
+
+## Requirements
+
+- Python `3.13` or later.
+- A Stash server and an API key for it. stashapp-cli is tested with Stash `v0.31.1`.
+- Optional: [jq](https://jqlang.org/), to read the JSON output in scripts. The
+  examples in the guides use it.
+
+## Install
+
+Install stashapp-cli from PyPI with [uv](https://docs.astral.sh/uv/) or
+[pipx](https://pipx.pypa.io/). The package is named `stashapp-cli`. The
+command it installs is `stashapp-cli`:
+
+```bash
+uv tool install stashapp-cli
+pipx install stashapp-cli
+```
+
+To install the latest code from GitHub, run:
+
+```bash
+uv tool install git+https://github.com/razputingh/stashapp-cli
+```
+
+## Connect to Stash
+
+stashapp-cli reads two environment variables. It has no credential flags or
+credential files.
+
+```bash
+export STASH_URL=http://localhost:9999
+export STASH_API_KEY=<key>
+```
+
+`STASH_URL` is the base URL of your Stash server. You make an API key in Stash
+under Settings > Security > Authentication. If a variable is not set, the
+command stops with exit status 4. For the other exit statuses, read
+[Errors and exit statuses][errors].
+
+## Quick start
+
+Make sure that your Stash server has every name that stashapp-cli uses. Run this
+command before the first write to a server, and after you upgrade Stash:
+
+```bash
+stashapp-cli introspect
+```
+
+Find a tag by its name or alias:
+
+```bash
+stashapp-cli tag find --name hd
+```
+
+Make the tag if it does not exist. Without `--apply`, the command only reports
+what it would send:
+
+```bash
+stashapp-cli tag find-or-create hd
+```
+
+```json
+{"applied": false, "operation": "tagCreate", "input": {"name": "hd"}}
+```
+
+Add `--apply` to make the change:
+
+```bash
+stashapp-cli tag find-or-create hd --apply
+```
+
+Each command has a `--help` output with its options and examples:
+
+```bash
+stashapp-cli --help
+stashapp-cli tag --help
+stashapp-cli tag merge --help
+```
+
+## Changes are dry runs by default
+
+Each command has one of three kinds. The `--help` output of a command states
+its kind.
+
+| Kind | What the command does |
+| --- | --- |
+| `read` | It never changes Stash. |
+| `write` | It changes Stash only with `--apply`. Else it reports the change. |
+| `destructive` | It can make a change that you cannot undo. |
+
+A destructive change needs both `--apply` and `--force`. You can put `--apply`
+anywhere in the command. Put `--force` after the command name, for example
+`stashapp-cli tag merge --destination 3 --source 7 --apply --force`.
+
+Before you merge or delete, back up the Stash database with
+`stashapp-cli backup --apply`.
+
+Do not use `--input` to add one tag, URL, or alias. A list in `--input`
+replaces the whole list in Stash, so the other values are removed. Use the add
+and remove options instead, for example
+`stashapp-cli scene update 812 --add-tag-id 55`.
+
+For the full rules, read [Writes are dry runs by default][writes] and
+[Updates replace lists][lists].
+
+## Commands
+
+Each command is a group followed by an action, for example `tag merge`. The
+[command reference][commands] has a table of all commands and their kinds.
+
+| Group | What it does |
+| --- | --- |
+| [`studio`][studio-cmd] | Get, find, create, and update studios. |
+| [`tag`][tag-cmd] | Get, find, create, update, delete, and merge tags. |
+| [`group`][group-cmd] | Get, find, create, and update groups, for example films. |
+| [`scene`][scene-cmd] | Get, find, and update scenes, and start identify jobs. |
+| [`performer`][performer-cmd] | Get, find, create, update, and merge performers. |
+| [`scrape`][scrape-cmd] | Get metadata from stash-boxes, scrapers, and URLs. |
+| [`scan`, `generate`, `job`][jobs-cmd] | Start scan and generate jobs, and wait for jobs. |
+| [`backup`][backup-cmd] | Back up the Stash database. |
+| [`stashbox`][stashbox-cmd] | Submit scene fingerprints to a stash-box. |
+| [`introspect`, `graphql`][graphql-cmd] | Check the schema, and send your own GraphQL. |
+
+## Documentation
+
+- [Usage][usage]: global options, input values, find filters, dry runs, and
+  list updates.
+- [Command reference][commands]: the behavior of each command.
+- [Guides][guides]: step-by-step tasks, such as how to merge duplicate tags.
+- [Errors and exit statuses][errors]: the JSON error object, the error codes,
+  and the exit statuses.
+- [Glossary][glossary]: the terms that these documents use.
+
+## Contributing
+
+Bug reports and pull requests are welcome. Read [CONTRIBUTING.md][contributing]
+for how to run the tests and how to add a command.
+
+## License
+
+stashapp-cli is released under the [MIT License][license].
+
+[writes]: docs/usage.md#writes-are-dry-runs-by-default
+[lists]: docs/usage.md#updates-replace-lists
+[commands]: docs/commands/README.md
+[studio-cmd]: docs/commands/studio.md
+[tag-cmd]: docs/commands/tag.md
+[group-cmd]: docs/commands/group.md
+[scene-cmd]: docs/commands/scene.md
+[performer-cmd]: docs/commands/performer.md
+[scrape-cmd]: docs/commands/scrape.md
+[jobs-cmd]: docs/commands/jobs.md
+[backup-cmd]: docs/commands/backup.md
+[stashbox-cmd]: docs/commands/stashbox.md
+[graphql-cmd]: docs/commands/graphql.md
+[usage]: docs/usage.md
+[guides]: docs/guides/README.md
+[errors]: docs/errors.md
+[glossary]: docs/glossary.md
+[contributing]: CONTRIBUTING.md
+[license]: LICENSE

stashapp_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,41 @@
+stashapp_cli/__init__.py,sha256=AzIUqyIfLYgFUqY8-disNtggT9c6ks2_JM9KYulAXCQ,58
+stashapp_cli/cli.py,sha256=WoFD8T49RCrRx-Bqwt7k_PY1pXFrnJBFejV37BOInvA,5258
+stashapp_cli/commands/__init__.py,sha256=cEN6-NiIu1qN1pVjYraQWLj9jjr8_Lsjgafh-hMHbpc,596
+stashapp_cli/commands/_common.py,sha256=9sJwM6-d5NT75ibbWZphMmGZKypXqZRyiuNs-NOpe8U,15849
+stashapp_cli/commands/backup.py,sha256=Tz8x7KIr-SiRHZGX7CnpJ6UYamhovzYqT1J3rtwKL1w,2481
+stashapp_cli/commands/generate.py,sha256=0rLxNDDsh41htZF9XzBwU2j1r8BBBnj_Y9ZfDqIWt3U,2826
+stashapp_cli/commands/graphql.py,sha256=mYII2b0_e8oQKeY23-_r39wFVB54LiEDe3zKOIRH9nQ,6833
+stashapp_cli/commands/group.py,sha256=hmtBVZbb7H9J6lSDiYtsjoIDI1JGq5gJ7HSuf5cL3w0,4401
+stashapp_cli/commands/introspect.py,sha256=9cmnNX0FHTIaxX0ImbW006kmLC35ZpGR63LuRnD2Uhs,956
+stashapp_cli/commands/job.py,sha256=G8CphGq3JkHs-PyhdAgidwE5z5Fg7b1Z7S_AX3ZMyFk,4053
+stashapp_cli/commands/performer.py,sha256=We4HF9PKbBVix369G6Dw_5TYfi4U5q-qwxoAOoTdaUw,12309
+stashapp_cli/commands/scan.py,sha256=tT2eERot-CzWfu1An4fr-gBF2FSaAmQZ1Idt7kPmqZw,2980
+stashapp_cli/commands/scene.py,sha256=zxeP1xLboXsQD-bvHQyyuSSrXNLLoScQBcn7j4Sq77Q,14020
+stashapp_cli/commands/scrape.py,sha256=5IXsJTmxEVEpw9QynI_D5rqcNTcI_siLOnsoD2h7C3o,4565
+stashapp_cli/commands/stashbox.py,sha256=DxNzfw8a-ZZWTIl6g5xqZkmW5rim8onA8dp3Ladmhnw,6238
+stashapp_cli/commands/studio.py,sha256=9O9ya3_xAZP1Ozk79jHx-X4kp6RJmw4I_gcOW7wZ25A,7343
+stashapp_cli/commands/tag.py,sha256=nK0FwTdzqz8FEuim1Y-ArU7J_PPZ_dZVwg4pfvzvOkA,24475
+stashapp_cli/core.py,sha256=24ACYGr41Nckrjdx96MHhTqmZcq4paDKdhkAeVtwWzs,5355
+stashapp_cli/images.py,sha256=D4tns44i9yxrvSFyUwRFVNuHndJ8fEvv-HV6dVlhcfY,2322
+stashapp_cli/introspect.py,sha256=JmgANDrYadEEnLNIVuH1KSJ2wHMBBSB6CaFdIIbJ8Ys,10076
+stashapp_cli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+stashapp_cli/queries/__init__.py,sha256=7r7JbMhv0M1aqZ6WXMP8pX31ss78IUOwNfx5aG6TjHs,931
+stashapp_cli/queries/_get.py,sha256=HszqEMbZhyQZRiQabOvESywYzOUlUBUfoUahwpFNOzA,978
+stashapp_cli/queries/_image_flags.py,sha256=Tj9jAZmM5Z6_sOVgx9BUM_93-A-5S-dfXbGBOmH9W_E,1005
+stashapp_cli/queries/backup.py,sha256=wwhfT6gLtfEQHl_DW5RaBQAZCf89qb9XedpvrD7RGs4,535
+stashapp_cli/queries/group.py,sha256=VlHwcCFePCbIbM12C4m20i1KLxti6PFDQ7ar8JRXzmY,2917
+stashapp_cli/queries/job.py,sha256=F3f7bRBgJLN7CrD3Us9JCd_DVrsM0Rx53cmHa1yRPkI,619
+stashapp_cli/queries/metadata.py,sha256=kGYk1OP02oXOLhrONOHdQ71JIlSGUeit194A9BGkX_I,1229
+stashapp_cli/queries/performer.py,sha256=cnpu2HA6X23I6JZ58JHXUB7XX9c4RjcEymIq1WR7oSI,4962
+stashapp_cli/queries/scene.py,sha256=WErgFDkRDu7Vo-AAMH512J9Ds8rZVjARbp-qXHFSESw,3806
+stashapp_cli/queries/scrape.py,sha256=SUb_t9_uiGYFXrR6NX1cLJuxFAktgPPbBuCGNaZ3TbM,3988
+stashapp_cli/queries/sources.py,sha256=Jcmk6zppA5WXVGyZgehf7iR2Gbn9izlVqVNTx87yKIo,2421
+stashapp_cli/queries/stashbox.py,sha256=TwZUQR1_xaMICt2vUnGyX0qmK2CB4V_HnrJNIZJe2kA,2136
+stashapp_cli/queries/studio.py,sha256=wS06I5kmwc5ow5qXxPRm9Ynpn3ENsS5TR_iF5Oam_pY,3661
+stashapp_cli/queries/tag.py,sha256=Ne-x29Eazd8tuKx6rtFBQYa7I1kUHuYIVeXYw2DkXB8,6650
+stashapp_cli/sources.py,sha256=lVNzMU_ac9MCVSRdGSKuLjX1pWBCC2TxM0v1q-BljZ8,4235
+stashapp_cli-0.1.0.dist-info/licenses/LICENSE,sha256=U2yKVpbNvfD5RmmKudZu-atrjDw5sEHMKmudBYEGJ3k,1067
+stashapp_cli-0.1.0.dist-info/WHEEL,sha256=MWx7psoF7KNST9G72pGtiBYuaXRXQXBk9pw5R6FzYko,80
+stashapp_cli-0.1.0.dist-info/entry_points.txt,sha256=48xiz1A3woEOKx80HRTUUOY6X5OaKUTlq3u6lWUNrCI,56
+stashapp_cli-0.1.0.dist-info/METADATA,sha256=TvctQ89xI9ix2NDk1lznYsPh9Qhd7zd-DfkqujziCto,7105
+stashapp_cli-0.1.0.dist-info/RECORD,,

stashapp_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.13.7
+Root-Is-Purelib: true
+Tag: py3-none-any

stashapp_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+stashapp-cli = stashapp_cli.cli:main
+

stashapp_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 razputingh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.