Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wangonya/cchat
Cli chat app made with Python & Twilio's Programmable Chat REST API
https://github.com/wangonya/cchat
Last synced: about 2 months ago
JSON representation
Cli chat app made with Python & Twilio's Programmable Chat REST API
- Host: GitHub
- URL: https://github.com/wangonya/cchat
- Owner: wangonya
- License: mit
- Created: 2020-04-03T18:20:56.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T09:42:55.000Z (about 2 years ago)
- Last Synced: 2023-03-03T04:21:59.371Z (almost 2 years ago)
- Language: Python
- Size: 77.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cchat
A cli chat application made with Python & Twilio's Programmable Chat REST API.
### How it works
This application provides a command line interface where registered users can chat on different channels.
## Features
- User registration with 2FA using Twilio's Authy API
- Terminal interface
- Chat using Twilio's Programmable Chat API
- Create and delete channels using the `/+channel` and `/-channel` commands
- Receive system notifications when your username is @mentioned in a channel
- Send sms to teammates right from the chat interface using the `/sms` command
## Set up
### Requirements
- Python 3
- Linux / MacOs terminal
- [ngrok](https://ngrok.com/) so we can expose our local port 8000 online for the chat webhook
### Twilio Account Settings
Before we begin, we need to collect
all the config values we need to run the application:
| Config Value | Description |
| :---------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Account Sid | Your primary Twilio account identifier - find this [in the Console](https://www.twilio.com/console). |
| Auth Token | Used to authenticate - [just like the above, you'll find this here](https://www.twilio.com/console). |
| Phone number | A Twilio phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164) - you can [get one here](https://www.twilio.com/console/phone-numbers/incoming) |
| Chat service SID | Programmable Chat service SID - - you can use SID of the default conversations service in your console or create a new chat service
| SMS service SID | Programmable SMS service SID - you can use SID of the default conversations service in your console or create a new sms service
| Authy API Key | Authy API key for authentication - you'll need to create an Authy app then get this from the settings
## Running The App
After the above requirements have been met:
1. Clone this repository and `cd` into it
```bash
git clone https://github.com/wangonya/cchat.git
cd cchat
```
2. Create and activate virtual environment
```bash
# I'll use virtualenv. You can use pipenv or whatever else you're comfortable with
virtualenv env
source env/bin/activate
```
3. Install dependencies
```bash
# With your virtual environment activated
pip install -r requirements.txt
```
4. Set your environment variables
I've provided a sample environment file `.sample.env`. All the values in it should be filled correctly.
```bash
cp .sample.env .env
```
In your `.env` file:
```bash
export ACCOUNT_SID=your account sid
export AUTH_TOKEN=your auth token
export CHAT_SERVICE_SID=your chat service sid
export SMS_SERVICE_SID=your sms service sid
export AUTHY_API_KEY=your authy api key
```
After you've filled everything out, run:
```bash
source .env
```
If any of these are not filled, the app will not run.
5. Run the application
This app has only been tested in unix terminals (linux & mac). I don't have access to a windows machine
so I was not able to test it for windows.
```bash
python app.py
```
6. User registration
As a new user, you will have to fill in some information to be registered.
Because we are using Authy, an email, country code and phone number is required.
An sms token will be sent to the phone number provided.
After providing the correct token, a username as a last step to identify you in the chat channels will be necessary.
Subsequent logins will be automatic.
7. ngrok
Once the app is running, a local server is begun in the background on port 8000. We need to attach this to our
webhook to be able to send and receive messages from others online.
In a different terminal, cd into where you have your ngrok and run:
```bash
./ngrok http 8000
```
This should give you a forwarding link, which you'll then need to copy into your webhook in the
Programmable Chat API settings.
Also make sure you check/enable the options marked in red.
### Using the app
- Send messages by typing in the input box at the bottom and pressing enter
- Create a new channel by running `/+channel CHANNEL_NAME`
- Delete a channel by running `/-channel CHANNEL_NAME`
- Change focus from the input area to the channels window and back by pressing `TAB`
- With the channels window in focus, switch channels using the up and down keys
- Send an sms by running `/sms PHONE_NUMBER MESSAGE`
PS: Chat history is saved in an in-memory sqlite database so it gets lost once
the app is closed.
You cannot run two sessions of this app at the same time because the port 8000 will already be in use.
To test out chatting between different users, you can set up one of the [starter apps](https://www.twilio.com/docs/chat/javascript/quickstart#download-configure-and-run-the-starter-app)
with the same credentials in the `.env` so that the app is connected to the same service.
Below is an example of a chat session between two web clients and the terminal client.
### Tests
The project does not have tests yet. TODO. |
## Resources
- [Twilio Authy](https://www.twilio.com/docs/authy)
- [Twilio Programmable Chat](https://www.twilio.com/docs/chat)
- [Twilio SMS](https://www.twilio.com/docs/sms)
- [Prompt Toolkit](https://python-prompt-toolkit.readthedocs.io/en/3.0.3/)
## Contributing
This project is open source and welcomes contributions.
## License
[MIT](http://www.opensource.org/licenses/mit-license.html)