| Name | aiotfm JSON |
| Version |
1.4.9
JSON |
| download |
| home_page | None |
| Summary | An asynchronous event based client for Transformice |
| upload_time | 2024-09-22 22:36:44 |
| maintainer | None |
| docs_url | None |
| author | Athesdrake |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2019-2022 AthesDrake Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
tranformice
client
async
atelier801
event
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# aiotfm
aiotfm is an asynchronous Client implementation of [Transformice](https://www.transformice.com/) that allows developers to make bots easily.
It uses an API endpoint to get the keys needed to connect to the game.
aiotfm is based on [TransFromage](https://github.com/Tocutoeltuco/transfromage) which use threads instead of coroutines.
If you prefer Lua over Python then checkout the [Lua version](https://github.com/Lautenschlager-id/Transfromage) made by [@Lautenschlager-id](https://github.com/Lautenschlager-id)
Join the **_[Fifty Shades of Lua](https://discord.gg/qmdryEB)_** [discord](https://discordapp.com/) server to discuss about this API and to receive special support.
## Keys Endpoint
This API depends on an [endpoint](https://api.tocu.tk/get_transformice_keys.php) that gives you access to the Transformice encryption keys.
To use it you will need a token which you can get by [applying through this form](https://forms.gle/N6Et1hLGQ9hmg95F6). See below to know the names of Transfromage managers who handle the token system.
- **[Tocutoeltuco](https://github.com/Tocutoeltuco)** @discord=> `Tocu#0018` <sub>`212634414021214209`</sub>;
- **[Blank3495](https://github.com/Blank3495)** @discord=> ` #8737` <sub>`436703225140346881`</sub>;
- **[Bolodefchoco](https://github.com/Lautenschlager-id)** @discord=> `Lautenschlager#2555` <sub>`285878295759814656`</sub>.
## Advantages
- 3 times faster than TransFromage
- Compatible with discord.py
- Faster
- Asynchronous
### Speed
TransFromage takes around 13 seconds to be connected to the community platform while aiotfm takes less than 4 seconds.
Those results can vary depending on your computer and your internet connection.
## Installation
You can install aiotfm using pip:
`pip install aiotfm`
To have a more up to date package, you have to clone this repository and install it manually:
```sh
git clone https://github.com/Athesdrake/aiotfm
cd aiotfm
python3 -m pip install .
```
### Requirements
aiotfm require python 3.7 or higher and [aiohttp](https://github.com/aio-libs/aiohttp).
### Python 3.6
Python 3.6 support is not guaranteed since [v1.4.3](https://github.com/Athesdrake/aiotfm/releases/tag/v1.4.3) as Python 3.6 has reached EOF.
#### Python 3.5
You can still use aiotfm with Python 3.5.3 or higher by cloning the repository and remove the sugar syntax of Python 3.6.
These changes are the typed variables and fstrings.
Due to a major update in the asynchronous stuff of Python 3.5.3, aiotfm is not compatible with the previous versions of Python.
### Update
To update aiotfm, use the following command:
`pip install -U aiotfm`
## Example
```Python
import aiotfm
bot = aiotfm.Client()
@bot.event
async def on_ready():
print('Connected to the community platform.')
bot.run("api_tfmid", "api_token", "username", "password", encrypted=False, room="start_room")
```
[A more complete example.](https://github.com/Athesdrake/aiotfm/blob/master/example_bot.py)
## Documentation
You can find the documentation of aiotfm [here](https://github.com/Athesdrake/aiotfm/tree/master/docs).
## About
You can have more information about TransFromage in this [thread](https://atelier801.com/topic?f=5&t=917024).
Raw data
{
"_id": null,
"home_page": null,
"name": "aiotfm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Athesdrake <athesdrake@gmail.com>",
"keywords": "TRANFORMICE, CLIENT, ASYNC, ATELIER801, EVENT",
"author": "Athesdrake",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/69/c9/0673367531ec20e0db9c127c0228039ea649c1329dcceeb4512b0e4960c4/aiotfm-1.4.9.tar.gz",
"platform": null,
"description": "# aiotfm\n\naiotfm is an asynchronous Client implementation of [Transformice](https://www.transformice.com/) that allows developers to make bots easily.\nIt uses an API endpoint to get the keys needed to connect to the game.\naiotfm is based on [TransFromage](https://github.com/Tocutoeltuco/transfromage) which use threads instead of coroutines.\n\nIf you prefer Lua over Python then checkout the [Lua version](https://github.com/Lautenschlager-id/Transfromage) made by [@Lautenschlager-id](https://github.com/Lautenschlager-id)\n\nJoin the **_[Fifty Shades of Lua](https://discord.gg/qmdryEB)_** [discord](https://discordapp.com/) server to discuss about this API and to receive special support.\n\n## Keys Endpoint\n\nThis API depends on an [endpoint](https://api.tocu.tk/get_transformice_keys.php) that gives you access to the Transformice encryption keys.\n\nTo use it you will need a token which you can get by [applying through this form](https://forms.gle/N6Et1hLGQ9hmg95F6). See below to know the names of Transfromage managers who handle the token system.\n- **[Tocutoeltuco](https://github.com/Tocutoeltuco)** @discord=> `Tocu#0018` <sub>`212634414021214209`</sub>;\n- **[Blank3495](https://github.com/Blank3495)** @discord=> `\udb40\udcaa\udb40\udcaa \udb40\udcaa\udb40\udcaa \udb40\udcaa\udb40\udcaa\udb40\udcaa\udb40\udcaa \udb40\udcaa\udb40\udcaa \udb40\udcaa\udb40\udcaa\udb40\udcaa\udb40\udcaa \udb40\udcaa\udb40\udcaa \udb40\udcaa\udb40\udcaa#8737` <sub>`436703225140346881`</sub>;\n- **[Bolodefchoco](https://github.com/Lautenschlager-id)** @discord=> `Lautenschlager#2555` <sub>`285878295759814656`</sub>.\n\n## Advantages\n\n- 3 times faster than TransFromage\n- Compatible with discord.py\n- Faster\n- Asynchronous\n\n### Speed\n\nTransFromage takes around 13 seconds to be connected to the community platform while aiotfm takes less than 4 seconds.\nThose results can vary depending on your computer and your internet connection.\n\n## Installation\n\nYou can install aiotfm using pip:\n`pip install aiotfm`\n\nTo have a more up to date package, you have to clone this repository and install it manually:\n```sh\ngit clone https://github.com/Athesdrake/aiotfm\ncd aiotfm\npython3 -m pip install .\n```\n\n### Requirements\n\naiotfm require python 3.7 or higher and [aiohttp](https://github.com/aio-libs/aiohttp).\n\n### Python 3.6\n\nPython 3.6 support is not guaranteed since [v1.4.3](https://github.com/Athesdrake/aiotfm/releases/tag/v1.4.3) as Python 3.6 has reached EOF.\n\n#### Python 3.5\n\nYou can still use aiotfm with Python 3.5.3 or higher by cloning the repository and remove the sugar syntax of Python 3.6.\nThese changes are the typed variables and fstrings.\nDue to a major update in the asynchronous stuff of Python 3.5.3, aiotfm is not compatible with the previous versions of Python.\n\n### Update\n\nTo update aiotfm, use the following command:\n`pip install -U aiotfm`\n\n## Example\n\n```Python\nimport aiotfm\n\nbot = aiotfm.Client()\n\n\n@bot.event\nasync def on_ready():\n\tprint('Connected to the community platform.')\n\nbot.run(\"api_tfmid\", \"api_token\", \"username\", \"password\", encrypted=False, room=\"start_room\")\n```\n\n[A more complete example.](https://github.com/Athesdrake/aiotfm/blob/master/example_bot.py)\n\n## Documentation\n\nYou can find the documentation of aiotfm [here](https://github.com/Athesdrake/aiotfm/tree/master/docs).\n\n## About\n\nYou can have more information about TransFromage in this [thread](https://atelier801.com/topic?f=5&t=917024).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2019-2022 AthesDrake Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "An asynchronous event based client for Transformice",
"version": "1.4.9",
"project_urls": {
"Bug Reports": "https://github.com/Athesdrake/aiotfm/issues",
"Homepage": "https://github.com/Athesdrake/aiotfm",
"Source": "https://github.com/Athesdrake/aiotfm"
},
"split_keywords": [
"tranformice",
" client",
" async",
" atelier801",
" event"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be308409e68a43946ae9d90fccfa5af1c01e67e3995dfcb617097c6d3b78aafb",
"md5": "48509d23402bb2afb7de7d9476ed1d02",
"sha256": "9424669caf8bfd8425227058f85fa621bafd3aad4ca4f11a010917ba62e6cf0f"
},
"downloads": -1,
"filename": "aiotfm-1.4.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48509d23402bb2afb7de7d9476ed1d02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 43398,
"upload_time": "2024-09-22T22:36:42",
"upload_time_iso_8601": "2024-09-22T22:36:42.891958Z",
"url": "https://files.pythonhosted.org/packages/be/30/8409e68a43946ae9d90fccfa5af1c01e67e3995dfcb617097c6d3b78aafb/aiotfm-1.4.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "69c90673367531ec20e0db9c127c0228039ea649c1329dcceeb4512b0e4960c4",
"md5": "9317b4e707b1423b6c177866770b4481",
"sha256": "daac543177007c61408f586bce8ba80868c30187b046dfb7dc86273c66b00b3e"
},
"downloads": -1,
"filename": "aiotfm-1.4.9.tar.gz",
"has_sig": false,
"md5_digest": "9317b4e707b1423b6c177866770b4481",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 41900,
"upload_time": "2024-09-22T22:36:44",
"upload_time_iso_8601": "2024-09-22T22:36:44.157433Z",
"url": "https://files.pythonhosted.org/packages/69/c9/0673367531ec20e0db9c127c0228039ea649c1329dcceeb4512b0e4960c4/aiotfm-1.4.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-22 22:36:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Athesdrake",
"github_project": "aiotfm",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "aiotfm"
}
