Skip to content

Commit

Permalink
Merge pull request #4 from green-api/SW-1731
Browse files Browse the repository at this point in the history
Updated docs
  • Loading branch information
Amele9 authored Jun 12, 2023
2 parents 703f030 + f08d476 commit a694b19
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# whatsapp-api-webhook-server-python

[![Python application](https://github.com/green-api/whatsapp-api-webhook-server-python/actions/workflows/python-app.yml/badge.svg?branch=master)](https://github.com/green-api/whatsapp-api-webhook-server-python/actions/workflows/python-app.yml)
[![Upload Python Package](https://github.com/green-api/whatsapp-api-webhook-server-python/actions/workflows/python-publish.yml/badge.svg)](https://github.com/green-api/whatsapp-api-webhook-server-python/actions/workflows/python-publish.yml)
![](https://img.shields.io/badge/license-CC%20BY--ND%204.0-green)
![](https://img.shields.io/pypi/status/whatsapp-api-webhook-server-python)
![](https://img.shields.io/pypi/pyversions/whatsapp-api-webhook-server-python)
![](https://img.shields.io/github/actions/workflow/status/green-api/whatsapp-api-webhook-server-python/python-app.yml)
![](https://img.shields.io/pypi/dm/whatsapp-api-webhook-server-python)

- [Документация на русском языке](docs/README_RU.md).
- [Документация на русском языке](https://github.com/green-api/whatsapp-api-webhook-server-python/blob/master/docs/README_RU.md).

whatsapp-api-webhook-server-python is a library for integration with WhatsApp messenger using the API
service [green-api.com](https://green-api.com/en/). You should get a registration token and an account ID in
Expand Down Expand Up @@ -76,7 +79,9 @@ Library installation:
python3 -m pip install whatsapp-api-webhook-server-python
```

As an example you can download and run [our script](examples/echo.py). The script sends all incoming notifications.
As an example you can download and run [our script](
https://github.com/green-api/whatsapp-api-webhook-server-python/blob/master/examples/echo.py
). The script sends all incoming notifications.

```shell
wget https://raw.githubusercontent.com/green-api/whatsapp-api-webhook-server-python/master/examples/echo.py
Expand Down Expand Up @@ -178,7 +183,7 @@ Method parameters:
| typeWebhook | type of incoming notification |
| body | notification body |

Example: [echo.py](examples/echo.py).
Example: [echo.py](https://github.com/green-api/whatsapp-api-webhook-server-python/blob/master/examples/echo.py).

## How to reroute incoming notifications to a web server

Expand All @@ -192,6 +197,6 @@ in [personal cabinet](https://console.green-api.com/).
## License

Licensed under [
Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)
Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)
](https://creativecommons.org/licenses/by-nd/4.0/) terms.
Please see file [LICENSE](LICENSE).
Please see file [LICENSE](https://github.com/green-api/whatsapp-api-webhook-server-python/blob/master/LICENSE).
9 changes: 6 additions & 3 deletions docs/README_RU.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# whatsapp-api-webhook-server-python

[![Python application](https://github.com/green-api/whatsapp-api-webhook-server-python/actions/workflows/python-app.yml/badge.svg?branch=master)](https://github.com/green-api/whatsapp-api-webhook-server-python/actions/workflows/python-app.yml)
[![Upload Python Package](https://github.com/green-api/whatsapp-api-webhook-server-python/actions/workflows/python-publish.yml/badge.svg)](https://github.com/green-api/whatsapp-api-webhook-server-python/actions/workflows/python-publish.yml)
![](https://img.shields.io/badge/license-CC%20BY--ND%204.0-green)
![](https://img.shields.io/pypi/status/whatsapp-api-webhook-server-python)
![](https://img.shields.io/pypi/pyversions/whatsapp-api-webhook-server-python)
![](https://img.shields.io/github/actions/workflow/status/green-api/whatsapp-api-webhook-server-python/python-app.yml)
![](https://img.shields.io/pypi/dm/whatsapp-api-webhook-server-python)

whatsapp-api-webhook-server-python - библиотека для интеграции с мессенджером WhatsApp через API
сервиса [green-api.com](https://green-api.com/). Чтобы воспользоваться библиотекой, нужно получить регистрационный токен
Expand Down Expand Up @@ -193,5 +196,5 @@ webhooksHandler.startServer('127.0.0.1', 80, onEvent)
## Лицензия

Лицензировано на условиях [
Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)
Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)
](https://creativecommons.org/licenses/by-nd/4.0/). [LICENSE](../LICENSE).
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(
name="whatsapp-api-webhook-server-python",
version="0.0.6",
version="0.0.7",
description=(
"This library helps you easily create"
" a Python server endpoint to receive WhatsApp message webhooks."
Expand Down

0 comments on commit a694b19

Please sign in to comment.