PrivateCoffee/matrix-supportbot
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
matrix-supportbot/README.md

70 lines
3 KiB
Markdown
Raw Permalink Normal View History

docs: update README with detailed features and usage Expanded the README with comprehensive details about the bot's capabilities, including its features, user and operator commands, installation steps, and usage instructions. This enhances clarity for new users and contributors on how to interact with and set up the bot effectively.
2024-08-18 17:00:44 +00:00
# Matrix Support Bot
feat: add initial version of Matrix Support Bot - Set up CI/CD workflow for Python package publishing to PyPI - Add MIT License for project - Create .gitignore file to exclude common Python and project files - Document project purpose and licensing in README.md - Add example configuration file (config.yaml.dist) - Define package metadata and dependencies in pyproject.toml - Implement SupportBot class for handling support tickets in Matrix - Implement main script for bot execution and configuration loading This initial commit establishes the structure and core functionality for the Matrix Support Bot project.
2024-08-18 15:33:56 +00:00
[![Support Private.coffee!](https://shields.private.coffee/badge/private.coffee-support%20us!-pink?logo=coffeescript)](https://private.coffee)
docs: add badges for Matrix, PyPI, and latest commit Enhanced the README with additional status badges for easier access to: - Matrix community link - PyPI package version and Python compatibility - License information - Latest Git commit These additions improve visibility and accessibility of relevant project details for users and contributors.
2024-08-18 17:31:10 +00:00
[![Matrix](https://shields.private.coffee/badge/Matrix-join%20us!-blue?logo=matrix)](https://matrix.to/#/#matrix-supportbot:private.coffee)
[![PyPI](https://shields.private.coffee/pypi/v/matrix-supportbot)](https://pypi.org/project/matrix-supportbot/)
[![PyPI - Python Version](https://shields.private.coffee/pypi/pyversions/matrix-supportbot)](https://pypi.org/project/matrix-supportbot/)
[![PyPI - License](https://shields.private.coffee/pypi/l/matrix-supportbot)](https://pypi.org/project/matrix-supportbot/)
[![Latest Git Commit](https://shields.private.coffee/gitea/last-commit/privatecoffee/matrix-supportbot?gitea_url=https://git.private.coffee)](https://git.private.coffee/privatecoffee/matrix-supportbot)
feat: add initial version of Matrix Support Bot - Set up CI/CD workflow for Python package publishing to PyPI - Add MIT License for project - Create .gitignore file to exclude common Python and project files - Document project purpose and licensing in README.md - Add example configuration file (config.yaml.dist) - Define package metadata and dependencies in pyproject.toml - Implement SupportBot class for handling support tickets in Matrix - Implement main script for bot execution and configuration loading This initial commit establishes the structure and core functionality for the Matrix Support Bot project.
2024-08-18 15:33:56 +00:00
docs: update README with detailed features and usage Expanded the README with comprehensive details about the bot's capabilities, including its features, user and operator commands, installation steps, and usage instructions. This enhances clarity for new users and contributors on how to interact with and set up the bot effectively.
2024-08-18 17:00:44 +00:00
Matrix Support Bot is a support ticket bot for the Matrix protocol built using the `matrix-nio` library. The bot allows users to open support tickets and communicate with support operators in a structured manner. Operators can manage tickets and relay messages between customer-facing and operator-facing rooms.
## Features
- The bot's state is stored in a Matrix room, so no external database is required.
- Users can invite the bot to a direct message (DM) and receive instructions on how to open a support ticket.
- Users can open support tickets using the `!supportbot openticket` command.
- The bot creates a new customer-facing room for each ticket and invites the user to it.
- Operators are notified of new tickets in a shared operator room.
- Operators can join operator-facing rooms for each ticket and communicate with customers.
- Messages between customer-facing and operator-facing rooms are relayed by the bot.
- Operators can close tickets and list open tickets using bot commands.
- Supports relaying of different message types, including text and media.
## Commands
### User Commands
- `!supportbot openticket` - Opens a new support ticket and creates a customer-facing room.
### Operator Commands
- `!supportbot invite <ticket_id>` - Invites an operator to the operator-facing room for the specified ticket.
- `!supportbot close <ticket_id>` - Closes the specified ticket.
- `!supportbot list` - Lists all open tickets.
## Installation
1. Install from PyPI:
```bash
pip install matrix-supportbot
```
2. Create a `config.yaml` file with your Matrix credentials and operator room ID:
```yaml
homeserver: "https://homeserver.example"
username: "your_username"
password: "your_password"
operator_room_id: "!your_operator_room_id:homeserver.example"
```
## Usage
Run the bot with the following command:
```bash
supportbot
```
The bot will log in to your Matrix server, join the operator room, and start listening for commands and invites.
## Contributing
Contributions are welcome! Please fork the repository and create a pull request with your changes.
feat: add initial version of Matrix Support Bot - Set up CI/CD workflow for Python package publishing to PyPI - Add MIT License for project - Create .gitignore file to exclude common Python and project files - Document project purpose and licensing in README.md - Add example configuration file (config.yaml.dist) - Define package metadata and dependencies in pyproject.toml - Implement SupportBot class for handling support tickets in Matrix - Implement main script for bot execution and configuration loading This initial commit establishes the structure and core functionality for the Matrix Support Bot project.
2024-08-18 15:33:56 +00:00
## License
docs: update README with detailed features and usage Expanded the README with comprehensive details about the bot's capabilities, including its features, user and operator commands, installation steps, and usage instructions. This enhances clarity for new users and contributors on how to interact with and set up the bot effectively.
2024-08-18 17:00:44 +00:00
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Reference in a new issue Copy permalink