Metadata-Version: 2.4
Name: stashapp-client
Version: 0.2.0
Summary: Python client for the Stash GraphQL API
Author-email: Written2001 <knasdkn@protonmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Written2001/stashapp_client
Project-URL: Repository, https://github.com/Written2001/stashapp_client
Project-URL: Issues, https://github.com/Written2001/stashapp_client/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: graphql-core>=3.2
Requires-Dist: pandas>=2.0
Requires-Dist: requests>=2.31
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: ruff>=0.6; extra == "dev"
Requires-Dist: mypy>=1.10; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.7; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.29; extra == "docs"
Dynamic: license-file

# stashapp-client

`stashapp-client` is an SDL-first Python client for the [Stash](https://github.com/stashapp/stash) GraphQL API. It provides schema-derived query and mutation methods, input validation, pagination, response extraction, and pandas DataFrame results.

## Install

```bash
python -m pip install stashapp-client
```

For development:

```bash
python -m pip install -e '.[dev,docs]'
```

## Documentation

Read the [full documentation](https://written2001.github.io/stashapp_client/), including:

- [Installation](https://written2001.github.io/stashapp_client/getting-started/installation/)
- [Connection and TLS](https://written2001.github.io/stashapp_client/getting-started/connection/)
- [First query](https://written2001.github.io/stashapp_client/getting-started/first-query/)
- [Queries and filters](https://written2001.github.io/stashapp_client/guide/queries-and-filters/)
- [Pagination](https://written2001.github.io/stashapp_client/guide/pagination/)
- [Mutations](https://written2001.github.io/stashapp_client/guide/mutations/)
- [Responses and DataFrames](https://written2001.github.io/stashapp_client/guide/responses-and-dataframes/)
- [Schema compatibility](https://written2001.github.io/stashapp_client/guide/schema-compatibility/)
- [Troubleshooting](https://written2001.github.io/stashapp_client/guide/troubleshooting/)
- [API reference](https://written2001.github.io/stashapp_client/reference/client/)
- [Filters and criteria reference](https://written2001.github.io/stashapp_client/reference/filters/)
- [Responses and errors reference](https://written2001.github.io/stashapp_client/reference/responses/)
- [Mutation plans reference](https://written2001.github.io/stashapp_client/reference/mutations/)
- [Schema generation](https://written2001.github.io/stashapp_client/development/schema-generation/)
- [Releases](https://written2001.github.io/stashapp_client/development/releases/)
- [Contributing](https://written2001.github.io/stashapp_client/development/contributing/)

## Project links

- [Source repository](https://github.com/Written2001/stashapp_client)
- [Issue tracker](https://github.com/Written2001/stashapp_client/issues)
- [PyPI package](https://pypi.org/project/stashapp-client/)
- [Changelog](CHANGELOG.md)
- [Contributing guide](CONTRIBUTING.md)
