Metadata-Version: 2.1
Name: suppgram
Version: 0.0.3
Summary: Minimalistic support system with Telegram-based UI
Author-email: Tigran Saluev <tigran@saluev.com>
Maintainer-email: Tigran Saluev <tigran@saluev.com>
License: MIT License
        
        Copyright (c) 2023 Tigran Saluev
        
        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.
        
Project-URL: Homepage, https://github.com/Saluev/suppgram
Project-URL: Documentation, https://suppgram.readthedocs.org
Project-URL: Repository, https://github.com/Saluev/suppgram.git
Project-URL: Issues, https://github.com/Saluev/suppgram/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click ~=8.1.7
Provides-Extra: dev
Requires-Dist: mkdocs ~=1.5.3 ; extra == 'dev'
Requires-Dist: mkdocstrings ~=0.24.0 ; extra == 'dev'
Requires-Dist: mkdocstrings-python ~=1.7.5 ; extra == 'dev'
Requires-Dist: mypy ~=1.7.1 ; extra == 'dev'
Requires-Dist: mypy-extensions ~=1.0.0 ; extra == 'dev'
Requires-Dist: pytest ~=7.4.2 ; extra == 'dev'
Requires-Dist: pytest-asyncio ~=0.21.1 ; extra == 'dev'
Requires-Dist: ruff ~=0.1.6 ; extra == 'dev'
Provides-Extra: mongodb
Requires-Dist: motor ~=3.3.2 ; extra == 'mongodb'
Provides-Extra: pubnub
Requires-Dist: aioconsole ~=0.6.2 ; extra == 'pubnub'
Requires-Dist: pubnub ~=7.3.1 ; extra == 'pubnub'
Provides-Extra: shell
Requires-Dist: aioconsole ~=0.6.2 ; extra == 'shell'
Provides-Extra: sqlalchemy
Requires-Dist: aiosqlite ~=0.19.0 ; extra == 'sqlalchemy'
Requires-Dist: asyncpg ~=0.29.0 ; extra == 'sqlalchemy'
Requires-Dist: SQLAlchemy ~=2.0.22 ; extra == 'sqlalchemy'
Provides-Extra: sqlalchemy_slim
Requires-Dist: SQLAlchemy ~=2.0.22 ; extra == 'sqlalchemy_slim'
Provides-Extra: telegram
Requires-Dist: python-telegram-bot ~=20.6 ; extra == 'telegram'

# Suppgram — simple Telegram-based support system

## What problem does it solve?

Small and medium-sized b2c businesses often face the necessity to hire multiple support agents to handle 
the flow of incoming requests from customers. But enterprise support systems are very expensive and quite
complex.

Suppgram provides a simple Telegram-based interface for your support agents, and a multitude of ways for your
customers to reach them.

## How does it work?

### 1. Customers contact your support service via a multitude of different mediums (Telegram bot, e-mail, etc.).

![](docs/images/customer_chat.png)

### 2. New customer requests are shown to your support agents, with possibility to assign a conversation to an agent or mark it with tags.

![](docs/images/agents_chat.png)

### 3. Support agents are assigned to conversations and are able to chat with the customers via a unified interface, eventually marking chats as resolved.

![](docs/images/agent_chat.png)

## How to use it?

See [Quickstart](https://suppgram.readthedocs.io/en/latest/usage/quickstart/)!


## How to contribute?

See [Contribution guide](https://suppgram.readthedocs.io/en/latest/development/contribution_guide/)!
