python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2026-04-08 16:37:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Merge remote-tracking branch 'origin/dev-3.x' into dev-3.x

Browse source
This commit is contained in:
Alex Root Junior 2019-11-23 19:54:16 +02:00
commit 6bbc01b08b
3 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/api/sending_files.md
View file

@ -49,9 +49,9 @@ text_file = BufferedInputFile(b"Hello, world!", filename="file.txt")
### BufferedInputFile(...) ### BufferedInputFile(...)
|Argument|Type|Description| |Argument|Type|Description|
|---|---|---| |---|---|---|
| buffer | `#!python3 bytes` | File path | | `buffer` | `#!python3 bytes` | File path |
| filename | `#!python3 str` | Custom filename to be presented to Telegram (Required) | | `filename` | `#!python3 str` | Custom filename to be presented to Telegram (Required) |
| chunk_size | `#!python3 int` | File chunks size (Default: `64 kb`) | | `chunk_size` | `#!python3 int` | File chunks size (Default: `64 kb`) |
Also you can read buffer from file: Also you can read buffer from file:
@ -62,6 +62,6 @@ file = BufferedInputFile.from_file("file.txt")
### BufferedInputFile.from_file(...) ### BufferedInputFile.from_file(...)
|Argument|Type|Description| |Argument|Type|Description|
|---|---|---| |---|---|---|
| path | `#!python3 Union[str, Path]` | File path | | `path` | `#!python3 Union[str, Path]` | File path |
| filename | `#!python3 Optional[str]` | Custom filename to be presented to Telegram | | `filename` | `#!python3 Optional[str]` | Custom filename to be presented to Telegram |
| chunk_size | `#!python3 int` | File chunks size (Default: `64 kb`) | | `chunk_size` | `#!python3 int` | File chunks size (Default: `64 kb`) |

2
docs/index.md
View file

@ -16,7 +16,7 @@ Documentation for version 3.0 [WIP] [^1]
## Features ## Features
- Asynchronous - Asynchronous
- [Supports Telegram Bot API v2.4](api/index.md) - [Supports Telegram Bot API v4.4](api/index.md)
- Finite State Machine - Finite State Machine
- [Replies into Webhook](https://core.telegram.org/bots/faq#how-can-i-make-requests-in-response-to-updates) - [Replies into Webhook](https://core.telegram.org/bots/faq#how-can-i-make-requests-in-response-to-updates)
- Middlewares - Middlewares

6
docs/install.md
View file

@ -1,6 +1,6 @@
# Installation Guide # Installation Guide
## Stable ## Stable (2.x)
### Using PIP ### Using PIP
```bash ```bash
pip install -U aiogram pip install -U aiogram
@ -20,11 +20,11 @@ poetry add aiogram
*aiogram* is also available in Arch User Repository, so you can install this library on any Arch-based distribution like ArchLinux, Antergos, Manjaro, etc. To do this, use your favorite AUR-helper and install [python-aiogram](https://aur.archlinux.org/packages/python-aiogram/) package. *aiogram* is also available in Arch User Repository, so you can install this library on any Arch-based distribution like ArchLinux, Antergos, Manjaro, etc. To do this, use your favorite AUR-helper and install [python-aiogram](https://aur.archlinux.org/packages/python-aiogram/) package.
## Development build ## Development build (3.x)
### From private PyPi index ### From private PyPi index
On every push to the `dev-3.x` branch GitHub Actions build the package and publish to the [2038.host](https://aiogram.2038.io/simple) server with seems like official PyPi files structure. That's mean you can always install latest (may be unstable) build via next command: On every push to the `dev-3.x` branch GitHub Actions build the package and publish to the [2038.host](https://aiogram.2038.io/simple) server with seems like official PyPi files structure. That's mean you can always install latest (may be unstable) build via next command:
```bash ```bash
pip install --extra-index-url https://aiogram.2038.io/simple --pre aiogram pip install --extra-index-url https://aiogram.2038.io/simple --pre aiogram
``` ```
In this repository available only last release. All previous builds is always removes before uploading new one. Also before building this package all tests is also pass. In this repository available only last success build. All previous builds is always removes before uploading new one. Also before building this package all tests is also pass.