| Name | slackish JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | |
| Summary | A Python module to access Slack's API from user-space, to circumvent all the artificial API limitations put in by greedy Salesforce. 🤑 |
| upload_time | 2023-10-14 22:05:09 |
| maintainer | |
| docs_url | None |
| author | Jérémie Lumbroso |
| requires_python | >=3.11,<4.0 |
| license | Unlicense |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# slackish
A Python module to access Slack's API from user-space, to circumvent all the artificial API limitations put in by greedy Salesforce. 🤑
## Why `slackish`?
While there exists an official Slack client for Python, Salesforce has introduced arbitrary restrictions on which API calls can be made based on different plans. This puts developers in a challenging position, as there's uncertainty regarding which API calls can be relied upon when building applications for others. `slackish` aims to provide a more reliable, robust, and less selective base for developers to build upon.
For example, `invites.py` shows you how to retrieve the list of invitations for your workspace, a feature that is only available to the API for Enterprise Grid customers.
## Installation
```bash
pip install slackish
```
## Usage
Here's a basic example of how to use `slackish`:
```python
import slackish
session = slackish.login_slack(
workspace="YOUR_WORKSPACE_NAME_OR_URL",
email="YOUR_EMAIL",
password="YOUR_PASSWORD"
)
print("Slack workspace: ", session.workspace)
print("Slack cookie: ", session.auth_cookie)
print("Slack token: ", session.auth_token)
```
Replace `YOUR_WORKSPACE_NAME_OR_URL`, `YOUR_EMAIL`, and `YOUR_PASSWORD` with your actual credentials.
## Features
- Bypass Salesforce's artificial API limitations.
- Reliable and consistent access to Slack's API.
- User-friendly interface for easy integration.
## Contributing
We welcome contributions! Please check out our [GitHub repository](https://github.com/jlumbroso/slackish) for more details.
The next milestone is to wrap the functionality in a sub-class `requests.Session()` that automatically injects the authentication cookie/token when appropriate.
## Disclaimer
Please ensure you're adhering to Slack's Terms of Service when using this package. The maintainers of `slackish` are not responsible for any misuse or violation of terms.
## License
This project is licensed under [The Unlicense](https://unlicense.org/).
It means you can do anything you want with this, for whatever purposes, you don't
have to credit me, this project, or anything.
Raw data
{
"_id": null,
"home_page": "",
"name": "slackish",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "J\u00e9r\u00e9mie Lumbroso",
"author_email": "lumbroso@seas.upenn.edu",
"download_url": "https://files.pythonhosted.org/packages/68/87/cc329b2373d3a64a1043d9de9e5f8e44f962a49ea48c4fcf58c35c847cbb/slackish-0.4.0.tar.gz",
"platform": null,
"description": "# slackish\n\nA Python module to access Slack's API from user-space, to circumvent all the artificial API limitations put in by greedy Salesforce. \ud83e\udd11\n\n## Why `slackish`?\n\nWhile there exists an official Slack client for Python, Salesforce has introduced arbitrary restrictions on which API calls can be made based on different plans. This puts developers in a challenging position, as there's uncertainty regarding which API calls can be relied upon when building applications for others. `slackish` aims to provide a more reliable, robust, and less selective base for developers to build upon.\n\nFor example, `invites.py` shows you how to retrieve the list of invitations for your workspace, a feature that is only available to the API for Enterprise Grid customers.\n\n## Installation\n\n```bash\npip install slackish\n```\n\n## Usage\n\nHere's a basic example of how to use `slackish`:\n\n```python\nimport slackish\n\nsession = slackish.login_slack(\n workspace=\"YOUR_WORKSPACE_NAME_OR_URL\",\n email=\"YOUR_EMAIL\",\n password=\"YOUR_PASSWORD\"\n)\n\nprint(\"Slack workspace: \", session.workspace)\nprint(\"Slack cookie: \", session.auth_cookie)\nprint(\"Slack token: \", session.auth_token)\n```\n\nReplace `YOUR_WORKSPACE_NAME_OR_URL`, `YOUR_EMAIL`, and `YOUR_PASSWORD` with your actual credentials.\n\n## Features\n\n- Bypass Salesforce's artificial API limitations.\n- Reliable and consistent access to Slack's API.\n- User-friendly interface for easy integration.\n\n## Contributing\n\nWe welcome contributions! Please check out our [GitHub repository](https://github.com/jlumbroso/slackish) for more details.\n\nThe next milestone is to wrap the functionality in a sub-class `requests.Session()` that automatically injects the authentication cookie/token when appropriate.\n\n## Disclaimer\n\nPlease ensure you're adhering to Slack's Terms of Service when using this package. The maintainers of `slackish` are not responsible for any misuse or violation of terms.\n\n## License\n\nThis project is licensed under [The Unlicense](https://unlicense.org/).\nIt means you can do anything you want with this, for whatever purposes, you don't\nhave to credit me, this project, or anything.\n\n\n",
"bugtrack_url": null,
"license": "Unlicense",
"summary": "A Python module to access Slack's API from user-space, to circumvent all the artificial API limitations put in by greedy Salesforce. \ud83e\udd11",
"version": "0.4.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb0b3d8a5629c76141ccefab3937387ca192ae01ef106876e942093ff54e372d",
"md5": "2c2d526d274524796db3939f296663f5",
"sha256": "fb935101d064ddf429737d39d3d155f13d72aaeff69cf2327d68c8195b076062"
},
"downloads": -1,
"filename": "slackish-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c2d526d274524796db3939f296663f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 6545,
"upload_time": "2023-10-14T22:05:07",
"upload_time_iso_8601": "2023-10-14T22:05:07.782591Z",
"url": "https://files.pythonhosted.org/packages/cb/0b/3d8a5629c76141ccefab3937387ca192ae01ef106876e942093ff54e372d/slackish-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6887cc329b2373d3a64a1043d9de9e5f8e44f962a49ea48c4fcf58c35c847cbb",
"md5": "3d3a962f6532ac23ccc3aa41bc22eea3",
"sha256": "5194ce9af82d5c083e785c35cde41dd0ecc5e4145410a5867da00bf686f4f133"
},
"downloads": -1,
"filename": "slackish-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "3d3a962f6532ac23ccc3aa41bc22eea3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 5246,
"upload_time": "2023-10-14T22:05:09",
"upload_time_iso_8601": "2023-10-14T22:05:09.476648Z",
"url": "https://files.pythonhosted.org/packages/68/87/cc329b2373d3a64a1043d9de9e5f8e44f962a49ea48c4fcf58c35c847cbb/slackish-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-14 22:05:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "slackish"
}
