Octra
========
.. epigraph::
⭐️ Thanks **everyone** who has starred the project, it means a lot!
|logo| **Octra** is an asyncio_ **Python 3**
MTProto_ library to interact with Telegram_'s API
as a user or through a bot account (bot API alternative).
.. important::
If you have code using Octra before its 1.0 version, you must
read `Compatibility and Convenience`_ to learn how to migrate.
What is this?
-------------
Telegram is a popular messaging application. This library is meant
to make it easy for you to write Python programs that can interact
with Telegram. Think of it as a wrapper that has already done the
heavy job for you, so you can focus on developing an application.
Installing
----------
.. code-block:: sh
pip3 install Octra
Creating a client
-----------------
.. code-block:: python
from Octra import TelegramClient, events, sync
# These example values won't work. You must get your own api_id and
# api_hash from https://my.telegram.org, under API Development.
api_id = 12345
api_hash = '0123456789abcdef0123456789abcdef'
client = TelegramClient('session_name', api_id, api_hash)
client.start()
Doing stuff
-----------
.. code-block:: python
print(client.get_me().stringify())
client.send_message('username', 'Hello! Talking to you from Octra')
client.send_file('username', '/home/myself/Pictures/holidays.jpg')
client.download_profile_photo('me')
messages = client.get_messages('username')
messages[0].download_media()
@client.on(events.NewMessage(pattern='(?i)hi|hello'))
async def handler(event):
await event.respond('Hey!')
Next steps
----------
Do you like how Octra looks? Check out `Read The Docs`_ for a more
in-depth explanation, with examples, troubleshooting issues, and more
useful information.
.. _asyncio: https://docs.python.org/3/library/asyncio.html
.. _MTProto: https://core.telegram.org/mtproto
.. _Telegram: https://telegram.org
.. _Compatibility and Convenience: https://docs.Octra.dev/en/stable/misc/compatibility-and-convenience.html
.. _Read The Docs: https://docs.Octra.dev
.. |logo| image:: logo.svg
:width: 24pt
:height: 24pt
Raw data
{
"_id": null,
"home_page": "https://github.com/LonamiWebs/Octra",
"name": "Octra",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "telegram api chat client library messaging mtproto",
"author": "Lonami Exo",
"author_email": "totufals@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/91/ef/8abfcb49293f17bfe7bea0cb4c694cae1cf05c094b81475b2718c914a2b8/Octra-1.1.4.tar.gz",
"platform": null,
"description": "Octra\r\n========\r\n.. epigraph::\r\n\r\n \u2b50\ufe0f Thanks **everyone** who has starred the project, it means a lot!\r\n\r\n|logo| **Octra** is an asyncio_ **Python 3**\r\nMTProto_ library to interact with Telegram_'s API\r\nas a user or through a bot account (bot API alternative).\r\n\r\n.. important::\r\n\r\n If you have code using Octra before its 1.0 version, you must\r\n read `Compatibility and Convenience`_ to learn how to migrate.\r\n\r\nWhat is this?\r\n-------------\r\n\r\nTelegram is a popular messaging application. This library is meant\r\nto make it easy for you to write Python programs that can interact\r\nwith Telegram. Think of it as a wrapper that has already done the\r\nheavy job for you, so you can focus on developing an application.\r\n\r\n\r\nInstalling\r\n----------\r\n\r\n.. code-block:: sh\r\n\r\n pip3 install Octra\r\n\r\n\r\nCreating a client\r\n-----------------\r\n\r\n.. code-block:: python\r\n\r\n from Octra import TelegramClient, events, sync\r\n\r\n # These example values won't work. You must get your own api_id and\r\n # api_hash from https://my.telegram.org, under API Development.\r\n api_id = 12345\r\n api_hash = '0123456789abcdef0123456789abcdef'\r\n\r\n client = TelegramClient('session_name', api_id, api_hash)\r\n client.start()\r\n\r\n\r\nDoing stuff\r\n-----------\r\n\r\n.. code-block:: python\r\n\r\n print(client.get_me().stringify())\r\n\r\n client.send_message('username', 'Hello! Talking to you from Octra')\r\n client.send_file('username', '/home/myself/Pictures/holidays.jpg')\r\n\r\n client.download_profile_photo('me')\r\n messages = client.get_messages('username')\r\n messages[0].download_media()\r\n\r\n @client.on(events.NewMessage(pattern='(?i)hi|hello'))\r\n async def handler(event):\r\n await event.respond('Hey!')\r\n\r\n\r\nNext steps\r\n----------\r\n\r\nDo you like how Octra looks? Check out `Read The Docs`_ for a more\r\nin-depth explanation, with examples, troubleshooting issues, and more\r\nuseful information.\r\n\r\n.. _asyncio: https://docs.python.org/3/library/asyncio.html\r\n.. _MTProto: https://core.telegram.org/mtproto\r\n.. _Telegram: https://telegram.org\r\n.. _Compatibility and Convenience: https://docs.Octra.dev/en/stable/misc/compatibility-and-convenience.html\r\n.. _Read The Docs: https://docs.Octra.dev\r\n\r\n.. |logo| image:: logo.svg\r\n :width: 24pt\r\n :height: 24pt\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Full-featured Telegram client library for Python 3",
"version": "1.1.4",
"split_keywords": [
"telegram",
"api",
"chat",
"client",
"library",
"messaging",
"mtproto"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "44c82604a4668fcade3eaa7e563ed250b50cd805fd904f3a5cebea87dda7c5c3",
"md5": "f4b0fc7354127a5fc2f2b986a5b330bf",
"sha256": "4ff062b09bc5bf59c90db03d91a33732d031a5276bbbbcd3c71ec67a6c4d6928"
},
"downloads": -1,
"filename": "Octra-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4b0fc7354127a5fc2f2b986a5b330bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 584669,
"upload_time": "2023-01-23T10:19:07",
"upload_time_iso_8601": "2023-01-23T10:19:07.768453Z",
"url": "https://files.pythonhosted.org/packages/44/c8/2604a4668fcade3eaa7e563ed250b50cd805fd904f3a5cebea87dda7c5c3/Octra-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91ef8abfcb49293f17bfe7bea0cb4c694cae1cf05c094b81475b2718c914a2b8",
"md5": "039fcf81d6ce47e952ceafafb67c30f5",
"sha256": "c4666952bb56a1c3c70dfb7a6bc6d50665fcb8b5a914c6c4c3f3483efccdb797"
},
"downloads": -1,
"filename": "Octra-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "039fcf81d6ce47e952ceafafb67c30f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 518873,
"upload_time": "2023-01-23T10:19:10",
"upload_time_iso_8601": "2023-01-23T10:19:10.765396Z",
"url": "https://files.pythonhosted.org/packages/91/ef/8abfcb49293f17bfe7bea0cb4c694cae1cf05c094b81475b2718c914a2b8/Octra-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-23 10:19:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "LonamiWebs",
"github_project": "Octra",
"lcname": "octra"
}
JSON
