python-telegram 0.17.0__tar.gz → 0.19.0__tar.gz

python_telegram-0.19.0/.dockerignore

@@ -0,0 +1,8 @@
+dist
+build
+.tdlib_files
+.tdlib_files*
+telegram/lib
+.tox
+.mypy_cache
+MANIFEST

python_telegram-0.19.0/.editorconfig

@@ -0,0 +1,23 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.py]
+charset = utf-8
+indent_style = space
+indent_size = 4
+line_length=80
+multi_line_output=3
+include_trailing_comma=True
+length_sort=1
+
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab

python_telegram-0.19.0/.github/dependabot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    reviewers:
+      - alexander-akhmetov
+    assignees:
+      - alexander-akhmetov
+    ignore:
+      - dependency-name: ipdb
+        versions:
+          - 0.13.5
+          - 0.13.6
+      - dependency-name: mypy
+        versions:
+          - '0.812'
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily

python_telegram-0.19.0/.github/stale.yml

@@ -0,0 +1,19 @@
+daysUntilStale: 180
+daysUntilClose: 30
+exemptLabels:
+  - pinned
+  - security
+  - bug
+  - dependencies
+  - help wanted
+  - good first issue
+  - enhancement
+
+staleLabel: stale
+
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+
+closeComment: false

python_telegram-0.19.0/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,39 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '33 11 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

python_telegram-0.19.0/.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: python-telegram tests
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5.1.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
+
+      - name: Tests
+        run: tox

python_telegram-0.19.0/.gitignore

@@ -0,0 +1,12 @@
+dist
+build
+python_telegram.egg-info
+.tdlib_files
+.tdlib_files*
+.tox
+.mypy_cache
+MANIFEST
+*.pyc
+.DS_Store
+.vscode
+telegram/_version.py

python_telegram-0.19.0/CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing
+
+Pull requests are welcome!
+
+Feel free to open an issue if you find a bug, have new ideas, suggestions, 
+or spot a mistake in the [documentation](https://python-telegram.readthedocs.io/en/latest/).
+
+## Reporting bugs
+
+We use [GitHub
+Issues](https://github.com/alexander-akhmetov/python-telegram/issues) to track
+bugs. If you find a bug, please open a new issue.
+
+Try to include steps to reproduce the bug, a detailed description, and some sample code if possible.
+
+## Pull request process
+
+1. Fork the repository and create a new branch from `master`.
+2. Make your changes and don't forget to add new tests :)
+3. Ensure the tests pass with your changes.
+4. Create a new PR!
+
+## Coding style
+
+The project uses [ruff](https://docs.astral.sh/ruff/) as an autoformatter and linter.
+
+## Tests
+
+To run tests you need to install [tox](https://tox.readthedocs.io/en/latest/).
+
+Run tests:
+
+```shell
+tox
+```
+
+Run a specific test using python 3.12:
+
+```shell
+tox -e py312 -- -k test_add_message_handler
+```

python_telegram-0.19.0/Dockerfile

@@ -0,0 +1,5 @@
+FROM python:3.10.0-bullseye
+
+RUN python3 -m pip install python-telegram
+
+ADD ./examples/*.py /app/examples/

python_telegram-0.19.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Alexander Akhmetov
+
+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.

{python-telegram-0.17.0 → python_telegram-0.19.0}/MANIFEST.in

@@ -9,3 +9,5 @@ recursive-include telegram/lib *
 recursive-include docs *
 
 global-exclude *.pyc
+
+include telegram/py.typed

python_telegram-0.19.0/Makefile

@@ -0,0 +1,37 @@
+.PHONY: docker/build
+docker/build:
+	docker build -f Dockerfile . -t akhmetov/python-telegram
+
+.PHONY: docker/send-message
+docker/send-message:
+	docker run -i -t \
+				-v /tmp/docker-python-telegram/:/tmp/ \
+				akhmetov/python-telegram \
+				python3 /app/examples/send_message.py $(API_ID) $(API_HASH) $(PHONE) $(CHAT_ID) $(TEXT)
+
+.PHONY: docker/echo-bot
+docker/echo-bot:
+	docker run -i -t \
+				-v /tmp/docker-python-telegram/:/tmp/ \
+				akhmetov/python-telegram \
+				python3 /app/examples/echo_bot.py $(API_ID) $(API_HASH) $(PHONE)
+
+.PHONY: docker/get-instant-view
+docker/get-instant-view:
+	docker run -i -t \
+				-v /tmp/docker-python-telegram/:/tmp/ \
+				akhmetov/python-telegram \
+				python3 /app/examples/echo_bot.py $(API_ID) $(API_HASH) $(PHONE)
+
+
+.PHONY: clean
+clean:
+	rm -rf dist
+
+.PHONY: build-pypi
+build-pypi: clean
+	python3 -m build
+
+.PHONY: release-pypi
+release-pypi:build-pypi
+	twine upload dist/*

python_telegram-0.19.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.1
+Name: python-telegram
+Version: 0.19.0
+Summary: Python library to help you build your own Telegram clients
+Author-email: Alexander Akhmetov <me@alx.cx>
+License: MIT
+Project-URL: Source, https://github.com/alexander-akhmetov/python-telegram
+Project-URL: Documentation, https://python-telegram.readthedocs.io/en/latest/
+Project-URL: Tutorial, https://python-telegram.readthedocs.io/en/latest/tutorial.html
+Project-URL: Changelog, https://python-telegram.readthedocs.io/en/latest/changelog.html
+Keywords: telegram,client,api,tdlib,tdjson,td
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: telegram-text==0.2.0
+
+# python-telegram
+
+[![Build Status](https://github.com/alexander-akhmetov/python-telegram/workflows/python-telegram%20tests/badge.svg)](https://github.com/alexander-akhmetov/python-telegram/actions)
+[![PyPI](https://img.shields.io/pypi/v/python-telegram.svg)](https://pypi.python.org/pypi/python-telegram)
+[![DockerHub](https://img.shields.io/docker/automated/akhmetov/python-telegram.svg)](https://hub.docker.com/r/akhmetov/python-telegram/)
+![Read the Docs (version)](https://img.shields.io/readthedocs/pip/stable.svg)
+
+Python API for the [tdlib](https://github.com/tdlib/td) library.
+It helps you build your own Telegram clients.
+
+- [Changelog](https://python-telegram.readthedocs.io/en/latest/changelog.html)
+- [Documentation](http://python-telegram.readthedocs.io)
+- [Tutorial](http://python-telegram.readthedocs.io/en/latest/tutorial.html)
+
+## Installation
+
+This library requires Python 3.9+ and Linux or MacOS. Windows is not supported.
+
+```shell
+pip install python-telegram
+```
+
+See [documentation](http://python-telegram.readthedocs.io/en/latest/#installation) for more details.
+
+### tdlib
+
+`python-telegram` comes with a precompiled `tdlib` library for Linux and MacOS. But it is highly recommended to [compile](https://tdlib.github.io/td/build.html) it yourself.
+The precompiled library may not work on some systems, it is dynamically linked and requires specific versions of additional libraries.
+
+```shell
+
+### Docker
+
+This library has a [docker image](https://hub.docker.com/r/akhmetov/python-telegram/):
+
+```sh
+docker run -i -t --rm \
+            -v /tmp/docker-python-telegram/:/tmp/ \
+            akhmetov/python-telegram \
+            python3 /app/examples/send_message.py $(API_ID) $(API_HASH) $(PHONE) $(CHAT_ID) $(TEXT)
+```
+
+## How to use the library
+
+Check out the [tutorial](http://python-telegram.readthedocs.io/en/latest/tutorial.html) for more details.
+
+Basic example:
+
+```python
+from telegram.client import Telegram
+from telegram.text import Spoiler
+
+tg = Telegram(
+    api_id='api_id',
+    api_hash='api_hash',
+    phone='+31611111111',  # you can pass 'bot_token' instead
+    database_encryption_key='changekey123',
+    files_directory='/tmp/.tdlib_files/',
+)
+tg.login()
+
+# If this is the first run, the library needs to preload all chats.
+# Otherwise, the message will not be sent.
+result = tg.get_chats()
+result.wait()
+
+chat_id: int
+result = tg.send_message(chat_id, Spoiler('Hello world!'))
+
+# `tdlib` is asynchronous, so `python-telegram` always returns an `AsyncResult` object.
+# You can receive a result with the `wait` method of this object.
+result.wait()
+print(result.update)
+
+tg.stop()  # You must call `stop` at the end of the script.
+```
+
+You can also use `call_method` to call any [tdlib method](https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1_function.html):
+
+``` python
+tg.call_method('getUser',  params={'user_id': user_id})
+```
+
+More examples can be found in the [/examples/ directory](/examples/).
+
+---
+
+More information is available in the [documentation](http://python-telegram.readthedocs.io).
+
+## Development
+
+See [CONTRIBUTING.md](/CONTRIBUTING.md).

{python-telegram-0.17.0 → python_telegram-0.19.0}/README.md

@@ -8,13 +8,13 @@
 Python API for the [tdlib](https://github.com/tdlib/td) library.
 It helps you build your own Telegram clients.
 
-* [Changelog](https://python-telegram.readthedocs.io/en/latest/changelog.html)
-* [Documentation](http://python-telegram.readthedocs.io)
-* [Tutorial](http://python-telegram.readthedocs.io/en/latest/tutorial.html)
+- [Changelog](https://python-telegram.readthedocs.io/en/latest/changelog.html)
+- [Documentation](http://python-telegram.readthedocs.io)
+- [Tutorial](http://python-telegram.readthedocs.io/en/latest/tutorial.html)
 
 ## Installation
 
-This library requires Python 3.6+ and Linux or MacOS.
+This library requires Python 3.9+ and Linux or MacOS. Windows is not supported.
 
 ```shell
 pip install python-telegram
@@ -22,6 +22,13 @@ pip install python-telegram
 
 See [documentation](http://python-telegram.readthedocs.io/en/latest/#installation) for more details.
 
+### tdlib
+
+`python-telegram` comes with a precompiled `tdlib` library for Linux and MacOS. But it is highly recommended to [compile](https://tdlib.github.io/td/build.html) it yourself.
+The precompiled library may not work on some systems, it is dynamically linked and requires specific versions of additional libraries.
+
+```shell
+
 ### Docker
 
 This library has a [docker image](https://hub.docker.com/r/akhmetov/python-telegram/):
@@ -33,11 +40,12 @@ docker run -i -t --rm \
             python3 /app/examples/send_message.py $(API_ID) $(API_HASH) $(PHONE) $(CHAT_ID) $(TEXT)
 ```
 
-## How to use
+## How to use the library
 
-Have a look at the [tutorial](http://python-telegram.readthedocs.io/en/latest/tutorial.html) :)
+Check out the [tutorial](http://python-telegram.readthedocs.io/en/latest/tutorial.html) for more details.
 
 Basic example:
+
 ```python
 from telegram.client import Telegram
 from telegram.text import Spoiler
@@ -51,26 +59,33 @@ tg = Telegram(
 )
 tg.login()
 
-# if this is the first run, library needs to preload all chats
-# otherwise the message will not be sent
+# If this is the first run, the library needs to preload all chats.
+# Otherwise, the message will not be sent.
 result = tg.get_chats()
 result.wait()
 
 chat_id: int
 result = tg.send_message(chat_id, Spoiler('Hello world!'))
-# `tdlib` is asynchronous, so `python-telegram` always returns you an `AsyncResult` object.
+
+# `tdlib` is asynchronous, so `python-telegram` always returns an `AsyncResult` object.
 # You can receive a result with the `wait` method of this object.
 result.wait()
 print(result.update)
 
-tg.stop()  # you must call `stop` at the end of the script
+tg.stop()  # You must call `stop` at the end of the script.
+```
+
+You can also use `call_method` to call any [tdlib method](https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1_function.html):
+
+``` python
+tg.call_method('getUser',  params={'user_id': user_id})
 ```
 
-More examples you can find in the [/examples/ directory](/examples/).
+More examples can be found in the [/examples/ directory](/examples/).
 
-----
+---
 
-More information in the [documentation](http://python-telegram.readthedocs.io).
+More information is available in the [documentation](http://python-telegram.readthedocs.io).
 
 ## Development
 

{python-telegram-0.17.0 → python_telegram-0.19.0}/docs/source/changelog.rst

@@ -2,6 +2,17 @@
 Changelog
 =========
 
+[unreleased]
+
+[0.19.0] 2024-06-23
+
+- Python versions 3.7 and 3.8 are no longer supported.
+- tdlib 1.8.31.
+
+[0.18.0] - 2023-03-13
+
+- Added support for tdlib > 1.8.5. (thanks to @JleMyP)
+
 [0.17.0] - 2023-01-25
 
 - Added ``import_contacts`` method. (thanks to @vlad-lf)