Metadata-Version: 2.1
Name: stashconnect
Version: 0.9.6
Summary: An API wrapper for stashcat and schul.cloud.
Home-page: https://github.com/BuStudios/StashConnect
Author: BuStudios
Author-email: support@bustudios.org
Project-URL: Bug Tracker, https://github.com/BuStudios/StashConnect/issues
Project-URL: Documentation, https://github.com/BuStudios/StashConnect/wiki
Project-URL: Source Code, https://github.com/BuStudios/StashConnect
Keywords: stashconnect,stashcat api,stashcat python,schul.cloud api,schul.cloud python,stashcat bot,schul.cloud bot
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: pycryptodome
Requires-Dist: python-socketio
Requires-Dist: Pillow
Requires-Dist: websocket-client

# StashConnect

StashConnect is an easy-to-use API wrapper for [stashcat](https://stashcat.com/) and [schul.cloud](https://schul.cloud).

![PyPI - Downloads](https://img.shields.io/pypi/dm/stashconnect?labelColor=345165&color=4793c9)
![PyPI - Version](https://img.shields.io/pypi/v/stashconnect?label=version&labelColor=345165&color=4793c9)
![PyPI - Status](https://img.shields.io/pypi/status/stashconnect?labelColor=345165&color=44af68)

## Installation

To install StashConnect, use pip in your shell:

```bash
pip install -U stashconnect
```

## Example Usage

```python
import stashconnect

client = stashconnect.Client(
    email="your email", password="your password",
    encryption_password="encryption password",
)

# change account settings
client.account.change_status("new status")
client.account.change_password("new", "old")

# upload or download files
client.files.upload("conversation_id", "hello.png")
client.files.download("file_id")

client.messages.send("conversation_id", "hello")
```

## Features to be added

- [x] docstrings
- [ ] account functions
- [ ] documentation
- [ ] bot class

## Contributors

- All code currently written by [BuStudios](https://github.com/bustudios)
- Create a pull request to contribute code yourself

## Disclaimer

StashConnect is not affiliated with Stashcat GmbH or any of its affiliates.

<img src="https://raw.githubusercontent.com/BuStudios/StashConnect/main/assets/icon-full.png">
