Bolt for Python News API App

This is a sample Slack app that sends news articles into Slack.

For the full details on how this project works, check out the tutorial on the Slack API site. Otherwise, continue reading.

日本の方はこちらの記事をご覧ください：https://qiita.com/hello_jun/items/418cca89c52eea13a3fa

Installation

Creating and setting up your Slack App

1. Open https://api.slack.com/apps/new and choose "From an app manifest"
2. Choose the workspace you want to install the application to
3. Copy the contents of manifest.json into the text box that says *Paste your manifest code here* (within the JSON tab) and click Next
4. Review the configuration and click Create
5. Click Install to Workspace and Allow on the screen that follows. You'll then be redirected to the App Configuration dashboard.

Environment Variables

Before you can run the app, you'll need to store some environment variables.

1. Open your apps configuration page from this list, click OAuth & Permissions in the left hand menu, then copy the Bot User OAuth Token. You will store this in your environment as SLACK_BOT_TOKEN.
2. Click *Basic Information from the left hand menu and follow the steps in the App-Level Tokens section to create an app-level token with the connections:write scope. Copy this token. You will store this in your environment as SLACK_APP_TOKEN.
3. Retrieve your News API key, which can be done for free if you are creating an app for development purposes. On the sign up page, fill in your name, e-mail address, and password, then choose "I am an individual" and submit the form. You will be granted an API key. Store this as the NEWS_API_KEY environment variable.

# Replace the sections in brackets with your tokens and keys
export SLACK_BOT_TOKEN=<your-bot-token>
export SLACK_APP_TOKEN=<your-app-token>
export NEWS_API_KEY=<your-api-key>

Setup Your Local Project

# Clone this project onto your machine
git clone https://github.com/slack-samples/bolt-python-news-api-for-slack.git

# Change into this project directory
cd bolt-python-news-api-for-slack

# Setup your python virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install the dependencies
pip install -r requirements.txt

# Start your local server
python3 app.py

Linting

# Run flake8 from root directory for linting
flake8 *.py && flake8 listeners/
# Run black from root directory for code formatting
black .

Project Structure

manifest.json

manifest.json is a configuration for Slack apps. With a manifest, you can create an app with a pre-defined configuration, or adjust the configuration of an existing app.

app.py

app.py is the entry point for the application and is the file you'll run to start the server. This project aims to keep this file as thin as possible, primarily using it as a way to route inbound requests.

/listeners/steps

Every incoming request is routed to a "listener". Inside this directory, you'll find the workflow_step.py file, which defines all the callback functions required to implement a Steps from Apps step.

/utils

/utils/articles.py

Contains class definitions that make the rest of the project code cleaner.

/utils/news_fetcher.py

Utility class that deals with interactions with the NewsAPI

App Distribution / OAuth

Only implement OAuth if you plan to distribute your application across multiple workspaces. A separate app-oauth.py file can be found with relevant OAuth settings.

When using OAuth, Slack requires a public URL where it can send requests. In this template app, we've used ngrok. Checkout this guide for setting it up.

Start ngrok to access the app on an external network and create a redirect URL for OAuth.

ngrok http 3000

This output should include a forwarding address for http and https (we'll use https). It should look something like the following:

Forwarding   https://3cb89939.ngrok.io -> http://localhost:3000

Navigate to OAuth & Permissions in your app configuration and click Add a Redirect URL. The redirect URL should be set to your ngrok forwarding address with the slack/oauth_redirect path appended. For example:

https://3cb89939.ngrok.io/slack/oauth_redirect