Develop (#27)

jacklowrie · web-flow · commit 3a3a01f26614 · 2022-11-26T15:34:16.000-05:00
* add app registration manifest and piazza icon * install instructions * readme formatting and clarity * add missing install instructions * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * temp contributing.md * update contributing and add venv to gitignore * bugfix: threaded message replies * install script * update readme * update readme * remove git conflict * update instructions to include install script * Feature reply in thread (#16) * Update issue templates * Delete CONTRIBUTING.md moving to .github * Revert "Update issue templates" This reverts commit 43cd34f. * Revert "Delete CONTRIBUTING.md" This reverts commit 25384ed. * Update issue templates * Create pull_request_template.md * Create pull_request_template.md * Update README.md * Update README.md * Update issue templates * Update feature_request.md * broadcast replies to unthreaded messages * delte test file * Feature update course (#21) * Develop (#19) * add app registration manifest and piazza icon * install instructions * readme formatting and clarity * add missing install instructions * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * temp contributing.md * update contributing and add venv to gitignore * bugfix: threaded message replies * install script * update readme * update readme * remove git conflict * update instructions to include install script * Feature reply in thread (#16) * Update issue templates * Delete CONTRIBUTING.md moving to .github * Revert "Update issue templates" This reverts commit 43cd34f. * Revert "Delete CONTRIBUTING.md" This reverts commit 25384ed. * Update issue templates * Create pull_request_template.md * Create pull_request_template.md * Update README.md * Update README.md * Update issue templates * Update feature_request.md * broadcast replies to unthreaded messages * delte test file * install tinydb and add slash command to upsert forum ids * remove course id from example .eng * store forum id in tinydb * move error message construction * formatting * formatting * update readme * add cache, rename Course -> Q (for query), move post_url building to message (#22) * fix regex
diff --git a/README.md b/README.md
@@ -8,8 +8,51 @@ post.
 **\*Note**: I am not affiliated with or endorsed by Piazza or Slack in any way. Neither
 is this bot.
 
+<<<<<<< HEAD
+## Installation (adding to your workspace, and updates)
+This app isn't registered through the slack app directory. For now, it's meant
+to be used by one workspace per install/instance. To add to your workspace,
+we need to do two things:
+1. Register a new app in your workspace, and add the appropriate permissions.
+2. Set the app up on your host.
+3. Once PiazzaBot is up and running, add it to any channel you want to use in.
+
+### Register the app (3-5 min)
+1. _[Register a new app](https://api.slack.com/apps?new_app=1) for your
+workspace._ Open that link (in a new window/tab). Choose to register the app
+from manifest, then copy & paste everything from the `slack-manifest.json`
+file in this repo into the window (make sure it's the `json` window and not
+the `yaml` window). Click through and confirm the app. This should take you
+to the "basic information" settings page.
+2. _Install to workspace._ Click the install to workspace button.
+3. _Add the piazza icon._ From the "basic information" page, at the bottom
+under "display information", upload the icon from this repo as the app icon.
+4. _Generate and save App-Level Token._ Under "App Level Tokens", generate a
+token with read/write authorizations. Note the token, as we'll need it to set
+the app up on your host.
+5. _save bot token._ Finally, note the bot token. In the left-side nav, click
+into "Features"->"Oauth & Permissions", and note the Bot User OAuth Token.
+
+### Host the app (3-5 min)
+
+1. _Clone this repo._ This is the easiest way to handle updates, since you
+can just pull from `main` and restart the app whenever there's an update.
+Alternatively, if you need to modify the app for your workspace, fork instead.
+2. _Install dependencies._ Set up a virtual environment, and install the
+required modules from `requirements.txt`. There's an install script `install.sh`
+which contains the commands you'll need to run. Either run each command
+individually, or try running the script **make sure python3 is installed on
+your system before running**.
+3. _Add tokens._ create a `.env` file from `.env-sample` and add the
+corresponding tokens you noted when registering the app.
+4. _Add Course ID._ Go to your course's dashboard (if you're viewing a question,
+click the logo). add the long alphanumeric string to your `.env` as the `COURSE_ID`.
+5. create new directory `data/` and a blank file `db.json` inside of it.
+6. _Run the app._ Run the app! `python app.py`
+=======
 ## Installation
 PiazzaBot now supports multiple workspaces, so installation is very straightforward. Just click the button above.
+>>>>>>> main
 
 ## Contributing
 Still thinking about the ideal workflow, however I'd like to keep PM on
diff --git a/app.py b/app.py
@@ -1,8 +1,10 @@
 import os
+
 from signal import signal, SIGINT
 from sys import exit
 
 from slack_bolt import App
+
 from slack_bolt.oauth.oauth_settings import OAuthSettings
 from slack_sdk.oauth.installation_store.sqlalchemy import SQLAlchemyInstallationStore
 from slack_sdk.oauth.state_store.sqlalchemy import SQLAlchemyOAuthStateStore
@@ -15,7 +17,9 @@
 from sqlalchemy import select
 from urllib import parse
 
+
 import re
+from tinydb import TinyDB, Query
 
 import logging
 logger = logging.getLogger(__name__)
@@ -126,13 +130,13 @@ def update_forum_id(ack, respond, command, context):
 
 # Listens for any message with a piazza tag in it. Piazza tags take the form
 # "@123", where the number is the id of a post on Piazza.
-#
 # https://regex101.com/r/eMmguY/1
-@app.message(re.compile(r"@(\d+\b)"))
+@app.message(re.compile(r"@(\d+[,|\ |\n|.|?|\r])"))
 def post_link(say, context, event, client):
     global cache
     forum_id = cache.get(context["team_id"], None)
 
+
     if forum_id is None:
         client.chat_postEphemeral(
             text=error,
