Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/YazdanRa/django-itelegram
It's a library for building Telegram bot on Django with extra built-in features
https://github.com/YazdanRa/django-itelegram
bot django pypi telegram
Last synced: 3 months ago
JSON representation
It's a library for building Telegram bot on Django with extra built-in features
- Host: GitHub
- URL: https://github.com/YazdanRa/django-itelegram
- Owner: YazdanRa
- License: mit
- Created: 2020-10-19T10:41:45.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-16T22:19:53.000Z (almost 4 years ago)
- Last Synced: 2024-07-09T16:36:00.110Z (4 months ago)
- Topics: bot, django, pypi, telegram
- Language: Python
- Homepage: https://pypi.org/project/Django-iTelegram/
- Size: 242 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://github.com/YazdanRa/django-itelegram/blob/master/itelegram/static/img/iTelegram.png?raw=true
.. image:: https://img.shields.io/pypi/pyversions/django-itelegram.svg
:target: https://pypi.python.org/pypi/django-itelegram/
.. image:: https://img.shields.io/pypi/v/django-itelegram.svg
:target: https://pypi.python.org/pypi/django-itelegram/
.. image:: https://img.shields.io/github/license/YazdanRa/django-itelegram.svg
:target: https://github.com/YazdanRa/django-itelegram/blob/master/LICENSE
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
-------
Django iTelegram
=================
It's a library for building Telegram bot on Django with extra built-in options.
created from `django-telegrambot`_ with a lot of extra features
Compatibility
=============
- Python: **3.5**, **3.6**, **3.7**, **3.8**
- Django: **3.0**, **3.1**, **3.2**
Installation
============
You can install this package by the PyPI with the following command line:
.. code-block:: sh
pip install django-itelegram
Configuration
==============
Add ``itelegram`` and your bot app to ``INSTALLED_APPS``:
.. code-block:: python
INSTALLED_APPS = [
# Other apps
"itelegram",
"YOUR_BOT_APP",
]
Then Add The ``DJANGO_TELEGRAMBOT`` to the settings just like the following structure:
.. code-block:: python
DJANGO_TELEGRAMBOT = {
"DISABLE_SETUP": False,
#
# TODO: Explain more about this key
"MODE": "POLLING", # (Optional [str])
#
# The default value is WEBHOOK, otherwise you may use "POLLING"
# NB: if use polling mode you must provide to run a management command that starts a worker
"WEBHOOK_SITE": "https://mywebsite.com", # Required on WEBHOOK mode
#
# TODO: Explain more
"WEBHOOK_PREFIX": "/prefix", # (Optional[str])
#
# If this value is specified, a prefix is added to webhook url
# "WEBHOOK_CERTIFICATE" : "cert.pem",
# If your site use self-signed certificate, must be set with location of your public key
# certificate.(More info at https://core.telegram.org/bots/self-signed )
"STRICT_INIT": True, # Optional[bool]
#
# TODO: Explain more about this key
"BOTS": [
{
"ID": "MyBot", # (Optional[str])
#
# You can use this ID to get your bot in all the installed apps
"TOKEN": "1062412615:AAHLZ974OBY3goSSoX6HePTapjgdJMYFnEY", # (Required[str])
#
# Your bot token.
# you can get it from ( https://t.me/BotFather )
"CONTEXT": True,
#
# TODO: Explain more about this key
# "ALLOWED_UPDATES": [], # (Optional[list[str]])
#
# List the types of updates you want your bot to receive.
# For example, specify ``["message", "edited_channel_post", "callback_query"]``
# to only receive updates of these types.
# See ``telegram.Update`` for a complete list of available update types.
# Specify an empty list to receive all updates regardless of type (default).
# If not specified, the previous setting will be used.
# Please note that this parameter doesn't affect updates created before the call to the setWebhook,
# so unwanted updates may be received for a short period of time.
# "TIMEOUT": 60, # (Optional[int|float])
#
# If this value is specified, use it as the read timeout from the server
# "WEBHOOK_MAX_CONNECTIONS": 40, # (Optional[int])
#
# Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100.
# Defaults to 40. Use lower values to limit the load on your bot's server,
# and higher values to increase your bot's throughput.
# "POLL_INTERVAL": 0.0, # (Optional[float])
#
# Time to wait between polling updates from Telegram in seconds.
# Default is 0.0
# "POLL_CLEAN": False, # (Optional[bool])
#
# Whether to clean any pending updates on Telegram servers before actually starting to poll.
# Default is False.
# "POLL_BOOTSTRAP_RETRIES": 0, # (Optional[int])
#
# Whether the bootstrapping phase of the `Updater`
# will retry on failures on the Telegram server.
# | < 0 - retry indefinitely
# | 0 - no retries (default)
# | > 0 - retry up to X times
# "POLL_READ_LATENCY": 2, # (Optional[float|int])
#
# Grace time in seconds for receiving the reply from server.
# Will be added to the `timeout` value and used as the read timeout from server.
# Default is 2
# "PROXY": {}, # (Optional[dict]),
#
# Use proxy to communicate with Telegram API server. Example:
# {
# "proxy_url": "socks5://ip:port",
# "urllib3_proxy_kwargs": {
# "username": "username",
# "password": "password"
# }
# }
# Default is not to use any proxy.
},
# Other bots here with same structure.
],
}
Add the following line to the url to configure the urls.
.. code-block:: python
urlpatterns = [
# Other urls patterns
path("itelegram/", include("itelegram.urls")),
]
Usage
=====
TODO :D
License
=======
`MIT`_
Note
====
(1) This is a fork from `django-telegrambot`_!
(2) Thanks to **Negar Nadian** for designing the Django iTelegram Logo.
.. _`django-telegrambot`: https://pypi.org/project/django-telegrambot/
.. _`MIT`: https://github.com/YazdanRa/django-itelegram/blob/master/LICENSE