# StashConnect
StashConnect is an easy-to-use API wrapper for [stashcat](https://stashcat.com/) and [schul.cloud](https://schul.cloud).
## Installation
To install StashConnect, use pip in your shell:
```bash
pip install -U stashconnect
```
## Example Usage
```python
import stashconnect
# without proxy / cert
client = stashconnect.Client(
email="your email", password="your password",
encryption_password="encryption password"
)
# with proxy & cert
proxies = {
'http': 'http://1.2.3.4:8080',
'https': 'http://5.6.7.8:8443',
}
client = stashconnect.Client(
email="your email", password="your password",
encryption_password="encryption password",
proxy = proxies,
cert_path = 'path/to/CA.pem'
)
# 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")
# get the last 30 messages of a chat
last_messages = client.messages.get_messages("channel_id/conversation_id")
for message in last_messages:
print(message.content)
```
## Features to be added
- [x] docstrings
- [ ] account functions
- [ ] documentation
- [ ] bot class
## Contributors
- Most code 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">
Raw data
{
"_id": null,
"home_page": "https://github.com/BuStudios/StashConnect",
"name": "stashconnect",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "stashconnect, stashcat api, stashcat python, schul.cloud api, schul.cloud python, stashcat bot, schul.cloud bot",
"author": "BuStudios",
"author_email": "support@bustudios.org",
"download_url": "https://files.pythonhosted.org/packages/d1/ab/4990b5a33e155d8e5e8cc8ddc1ac2cbd8b770b21045ad386a309a5ab9be7/stashconnect-0.9.7.6.tar.gz",
"platform": null,
"description": "# StashConnect\r\n\r\nStashConnect is an easy-to-use API wrapper for [stashcat](https://stashcat.com/) and [schul.cloud](https://schul.cloud).\r\n\r\n\r\n\r\n\r\n\r\n## Installation\r\n\r\nTo install StashConnect, use pip in your shell:\r\n\r\n```bash\r\npip install -U stashconnect\r\n```\r\n\r\n## Example Usage\r\n\r\n```python\r\nimport stashconnect\r\n\r\n# without proxy / cert\r\nclient = stashconnect.Client(\r\n email=\"your email\", password=\"your password\",\r\n encryption_password=\"encryption password\"\r\n)\r\n\r\n# with proxy & cert\r\nproxies = {\r\n 'http': 'http://1.2.3.4:8080',\r\n 'https': 'http://5.6.7.8:8443',\r\n}\r\n\r\nclient = stashconnect.Client(\r\n email=\"your email\", password=\"your password\",\r\n encryption_password=\"encryption password\",\r\n proxy = proxies, \r\n cert_path = 'path/to/CA.pem'\r\n)\r\n\r\n# change account settings\r\nclient.account.change_status(\"new status\")\r\nclient.account.change_password(\"new\", \"old\")\r\n\r\n# upload or download files\r\nclient.files.upload(\"conversation_id\", \"hello.png\")\r\nclient.files.download(\"file_id\")\r\n\r\nclient.messages.send(\"conversation_id\", \"hello\")\r\n\r\n# get the last 30 messages of a chat\r\nlast_messages = client.messages.get_messages(\"channel_id/conversation_id\")\r\nfor message in last_messages:\r\n print(message.content)\r\n```\r\n\r\n\r\n## Features to be added\r\n\r\n- [x] docstrings\r\n- [ ] account functions\r\n- [ ] documentation\r\n- [ ] bot class\r\n\r\n## Contributors\r\n\r\n- Most code written by [BuStudios](https://github.com/bustudios)\r\n- Create a pull request to contribute code yourself\r\n\r\n## Disclaimer\r\n\r\nStashConnect is not affiliated with Stashcat GmbH or any of its affiliates.\r\n\r\n<img src=\"https://raw.githubusercontent.com/BuStudios/StashConnect/main/assets/icon-full.png\">\r\n",
"bugtrack_url": null,
"license": null,
"summary": "An API wrapper for stashcat and schul.cloud.",
"version": "0.9.7.6",
"project_urls": {
"Bug Tracker": "https://github.com/BuStudios/StashConnect/issues",
"Documentation": "https://github.com/BuStudios/StashConnect/wiki",
"Homepage": "https://github.com/BuStudios/StashConnect",
"Source Code": "https://github.com/BuStudios/StashConnect"
},
"split_keywords": [
"stashconnect",
" stashcat api",
" stashcat python",
" schul.cloud api",
" schul.cloud python",
" stashcat bot",
" schul.cloud bot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e4a052c62dff04445cf7d6a57a315df1fa3044f0b7eb344bda212ed6e3ab5b7",
"md5": "edbb2afcb6030bad75467cc640571a5e",
"sha256": "ef7b7bb10e46e1fbd1194496cfa625301601f5a2357c5cbe01634ffded53bf33"
},
"downloads": -1,
"filename": "stashconnect-0.9.7.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "edbb2afcb6030bad75467cc640571a5e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 25515,
"upload_time": "2024-12-05T19:09:52",
"upload_time_iso_8601": "2024-12-05T19:09:52.464102Z",
"url": "https://files.pythonhosted.org/packages/4e/4a/052c62dff04445cf7d6a57a315df1fa3044f0b7eb344bda212ed6e3ab5b7/stashconnect-0.9.7.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d1ab4990b5a33e155d8e5e8cc8ddc1ac2cbd8b770b21045ad386a309a5ab9be7",
"md5": "d81c48ed86b7efa200f2756e185b0c19",
"sha256": "674d9cf3f8922b6349edcdea5e816da910a36ab1bacd2f30a7296cf7cc3726d1"
},
"downloads": -1,
"filename": "stashconnect-0.9.7.6.tar.gz",
"has_sig": false,
"md5_digest": "d81c48ed86b7efa200f2756e185b0c19",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 21271,
"upload_time": "2024-12-05T19:09:53",
"upload_time_iso_8601": "2024-12-05T19:09:53.600674Z",
"url": "https://files.pythonhosted.org/packages/d1/ab/4990b5a33e155d8e5e8cc8ddc1ac2cbd8b770b21045ad386a309a5ab9be7/stashconnect-0.9.7.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-05 19:09:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BuStudios",
"github_project": "StashConnect",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "stashconnect"
}
JSON
