Grindr
==================
A silly little library to connect to Grindr's mobile services.
## If You Work at Grindr
- Send me a message `info@isaackogan.com` for any questions/concerns.
- If you are hiring, send an e-mail. Let's chat :)!
## Table of Contents
- [Getting Started](#getting-started)
- [Licensing](#license)
- [Contributors](#contributors)
## Getting Started
1. Install the module via pip from the [PyPi](https://pypi.org/project/Grindr/) repository
```shell script
pip install Grindr
```
2. Create your first chat connection
```python
from Grindr import GrindrClient
from Grindr.events import ConnectEvent, MessageEvent
# Create the client
client: GrindrClient = GrindrClient()
# Listen to an event with a decorator!
@client.on(ConnectEvent)
async def on_connect(_: ConnectEvent):
print(f"Connected to Grindr!")
# Or, add it manually via "client.add_listener()"
async def on_message(event: MessageEvent) -> None:
if not event.type == "Text":
return
print(f"{event.senderId} -> {event.body.text}")
client.add_listener(MessageEvent, on_message)
if __name__ == '__main__':
# Run the client and block the main thread
# await client.start() to run non-blocking
client.run(
email="your@email.com",
password="your_secure_password"
)
```
### Helpful Tips
- Access all web-scraping methods with `client.web`
- Send messages with `await client.send(...)`
- Use proxies. Cloudflare WAF likes to ban IPs.
## Contributors
* **Isaac Kogan** - *Creator, Primary Maintainer, and Reverse-Engineering* - [isaackogan](https://github.com/isaackogan)
See also the full list of [contributors](https://github.com/isaackogan/Grindr/contributors) who have participated in
this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/isaackogan/Grindr",
"name": "Grindr",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Grindr, Grindr API, python3, api, unofficial",
"author": "Isaac Kogan",
"author_email": "info@isaackogan.com",
"download_url": "https://files.pythonhosted.org/packages/ff/c1/90595b6e2728f7227bff31cd275829835d5bdee58304e7812adc04916daa/grindr-0.1.5.tar.gz",
"platform": null,
"description": "Grindr\n==================\nA silly little library to connect to Grindr's mobile services.\n\n\n\n\n\n## If You Work at Grindr\n\n- Send me a message `info@isaackogan.com` for any questions/concerns.\n- If you are hiring, send an e-mail. Let's chat :)!\n\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n- [Licensing](#license)\n- [Contributors](#contributors)\n\n## Getting Started\n\n1. Install the module via pip from the [PyPi](https://pypi.org/project/Grindr/) repository\n\n```shell script\npip install Grindr\n```\n\n2. Create your first chat connection\n\n```python\nfrom Grindr import GrindrClient\nfrom Grindr.events import ConnectEvent, MessageEvent\n\n# Create the client\nclient: GrindrClient = GrindrClient()\n\n# Listen to an event with a decorator!\n@client.on(ConnectEvent)\nasync def on_connect(_: ConnectEvent):\n print(f\"Connected to Grindr!\")\n\n\n# Or, add it manually via \"client.add_listener()\"\nasync def on_message(event: MessageEvent) -> None:\n \n if not event.type == \"Text\":\n return\n \n print(f\"{event.senderId} -> {event.body.text}\")\n\n\nclient.add_listener(MessageEvent, on_message)\n\nif __name__ == '__main__':\n # Run the client and block the main thread\n # await client.start() to run non-blocking\n client.run(\n email=\"your@email.com\",\n password=\"your_secure_password\"\n )\n```\n\n### Helpful Tips\n\n- Access all web-scraping methods with `client.web`\n- Send messages with `await client.send(...)`\n- Use proxies. Cloudflare WAF likes to ban IPs.\n\n## Contributors\n\n* **Isaac Kogan** - *Creator, Primary Maintainer, and Reverse-Engineering* - [isaackogan](https://github.com/isaackogan)\n\nSee also the full list of [contributors](https://github.com/isaackogan/Grindr/contributors) who have participated in\nthis project.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Grindr Python Client",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/isaackogan/Grindr"
},
"split_keywords": [
"grindr",
" grindr api",
" python3",
" api",
" unofficial"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "72498c4d8d7a92008bbb97e528eb63ff343de400c9168473bbe46e07603f9c9b",
"md5": "1dd295d92512eeee8d089757a62b48cc",
"sha256": "fb00ed4c4324b91431041b55e35d37829d30074733ca9a61baccf182ce4ffb22"
},
"downloads": -1,
"filename": "Grindr-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1dd295d92512eeee8d089757a62b48cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 41391,
"upload_time": "2024-08-09T00:41:34",
"upload_time_iso_8601": "2024-08-09T00:41:34.580587Z",
"url": "https://files.pythonhosted.org/packages/72/49/8c4d8d7a92008bbb97e528eb63ff343de400c9168473bbe46e07603f9c9b/Grindr-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ffc190595b6e2728f7227bff31cd275829835d5bdee58304e7812adc04916daa",
"md5": "714f537afc57281712597f421346772c",
"sha256": "f56c72dd9e0f9328a3c80ffbe21bc8971c5e2e46e6531d0f1f9c77f14087718e"
},
"downloads": -1,
"filename": "grindr-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "714f537afc57281712597f421346772c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25708,
"upload_time": "2024-08-09T00:41:35",
"upload_time_iso_8601": "2024-08-09T00:41:35.993418Z",
"url": "https://files.pythonhosted.org/packages/ff/c1/90595b6e2728f7227bff31cd275829835d5bdee58304e7812adc04916daa/grindr-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-09 00:41:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "isaackogan",
"github_project": "Grindr",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "grindr"
}
JSON
