Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cskartikey/nest-bot
https://github.com/cskartikey/nest-bot
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/cskartikey/nest-bot
- Owner: cskartikey
- Created: 2023-09-13T12:39:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-26T09:07:56.000Z (9 months ago)
- Last Synced: 2024-04-26T10:26:51.653Z (9 months ago)
- Language: Python
- Size: 107 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nest Bot - Slack Bot for Nest Registration
Nest Bot is a Slack bot designed to simplify the Nest registration process for users. It allows users to register for Nest using their Slack username and public SSH key.
## Installation and Deployment
Follow these steps to deploy Nest Bot in your environment:
### Prerequisites
- Python 3.8+
- PostgreSQL Database
- Slack App and Bot Token
### Setup the Database
1. Create a PostgreSQL database and schema for Nest Bot:
```sql
CREATE SCHEMA nest_bot;
```
2. Create the `users` table to store user registration data:
```sql
CREATE TABLE nest_bot.users (
id SERIAL PRIMARY KEY,
slack_user_id VARCHAR(255) UNIQUE NOT NULL,
tilde_username VARCHAR(255) UNIQUE NOT NULL,
name VARCHAR(255),
email VARCHAR(255),
ssh_public_key TEXT NOT NULL,
description TEXT NOT NULL,
is_approved BOOLEAN DEFAULT FALSE,
created_at TIMESTAMP WITH TIME ZONE DEFAULT '1970-01-01 00:00:00 UTC';
);
```
3. Grant usage on the `nest_bot` schema to your PostgreSQL user:
```sql
GRANT USAGE ON SCHEMA nest_bot TO your_postgresql_user;
```
### Environment Variables
Create a `.env` file in your project's root directory and add the following environment variables:
```dotenv
SLACK_BOT_TOKEN=your_slack_bot_token
SQL_DATABASE="your_database_name"
SQL_HOST="your_database_host"
SQL_USER="your_database_user"
SQL_PASSWORD="your_database_password"
SQL_PORT="your_database_port"
SLACK_APP_TOKEN=your_slack_app_token
```
Replace `your_slack_bot_token`, `your_database_name`, `your_database_host`, `your_database_user`, `your_database_password`, `your_database_port`, and `your_slack_app_token` with your specific values.
### Install Dependencies
Note: Switch to psycopg2 **NOT BINARY** on production
Install the required Python dependencies using the `requirements.txt` file:
```bash
pip install -r requirements.txt
```
### Running Nest Bot
Start Nest Bot using the following command:
```bash
python your_app_filename.py
```
Replace `your_app_filename.py` with the name of the Python script where your Nest Bot code is located.