{"id":20040342,"url":"https://github.com/cvitter/mattermost-standup-slash","last_synced_at":"2025-05-05T08:31:59.356Z","repository":{"id":150376567,"uuid":"127157845","full_name":"cvitter/mattermost-standup-slash","owner":"cvitter","description":"Flask adaptation of George Goldberg's AWS Lambda based Standup Slash command: https://grundleborg.github.io/posts/mattermost-custom-slash-command-aws-lambda/","archived":false,"fork":false,"pushed_at":"2018-08-21T20:00:21.000Z","size":85,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-08T19:35:00.559Z","etag":null,"topics":["flask","mattermost","python","slash-commands"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cvitter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-28T15:05:27.000Z","updated_at":"2023-04-01T00:43:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"d1ba157c-e2c1-4bac-b511-cebbb289f964","html_url":"https://github.com/cvitter/mattermost-standup-slash","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvitter%2Fmattermost-standup-slash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvitter%2Fmattermost-standup-slash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvitter%2Fmattermost-standup-slash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvitter%2Fmattermost-standup-slash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cvitter","download_url":"https://codeload.github.com/cvitter/mattermost-standup-slash/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252466679,"owners_count":21752409,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","mattermost","python","slash-commands"],"created_at":"2024-11-13T10:41:42.342Z","updated_at":"2025-05-05T08:31:59.343Z","avatar_url":"https://github.com/cvitter.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mattermost Standup Slash Command\n\nThe following code is a Flask based adaptation of George Goldberg's (https://github.com/grundleborg) AWS Lambda based Standup Slash command: https://grundleborg.github.io/posts/mattermost-custom-slash-command-aws-lambda/\n\n **Import Note**: This application is not really designed for production use. It is meant \n only to demonstrate how to build useful slash commands using commonly\n available tools like Python and Flask (http://flask.pocoo.org/).\n \n# Installing the Slash Command\n\nIn order to use this slash command on your Mattermost server you will need:\n\n* A Mattermost server on which you have permissions to add slash commands;\n* A server on which you can install and run Python code that the Mattermost server can talk to;\n\nIf you have the two things above you can proceed to the installation steps below:\n\n## Setup the Flask Application\n\nThe following steps\n\n1. Log into the machine that will host the Python Flask application;\n2. Clone this repository to your machine: `git clone https://github.com/cvitter/mattermost-standup-slash.git`;\n3. Run the Flask application - there are a number of ways to run the application but I use the following command that runs the application headlessly and captures output into a log file for troubleshooting:\n\n```\nsudo python standup.py \u003e\u003e standup.log 2\u003e\u00261 \u0026\n```\n\n**Note**: The app by default will be available on port 5004. If you need to change ports please see the config file\n\n\n**Config**: the bot supports a handfull of basic config options which can be set in the config file.\n\n```\n\nlisten_port = 5004 - Port Value of your choosing\ntag_date_format = mdy  -  mdy or ydm\ncompact_date = False  -  True or False\ninclude_channel = True  -  True or False\n\n```\n\n## Setup the Slash Command\n\nNow that the Flask application is running you have to configure your slash command in Mattermost to connect to the \napplication. Inside of Mattermost:\n\n1. Click on the **Main Menu** (located in the left hand side bar next to your team and user name);\n2. Select **Integrations** from the drop down menu;\n3. Click on **Slash Commands**;\n4. Click on **Add Slash Command**;\n5. Fill in the form (refer to Mattermost help for full explanations of each field):\n\t1. Title - your choice (i.e. Standup)\n\t2. Description - your choice again;\n\t3. Command Trigger Word - standup\n\t4. Request URL - the URL of your flask application (i.e. http://something.com:5004/standup)\n\t5. Response Username - optional\n\t6. Response Icon - optional\n\t7. Autocomplete - check this so your users know that the slash command exists\n\t8. Autocomplete Hint - '[Your status update]'\n\t9. Autocomplete Description - 'Posts your daily Standup status formatted automatically with appropriate hashtags'\n6. Click **Save** to create the slash command.\n7. Test the slash command from within Mattermost and profit!\n\n# Using the Slash Command\n\nOnce the slash command is set up it is quite easy to use. Type '/standup' and begin entering your markdown formatted status update as demonstrated below:\n\n![Screenshot of the sample status being entered](images/typing-in-status.png)\n\nIf you were to submit the status above the command should return the following:\n\n![Screenshot of the sample return status](images/status-returned.png)\n\nIf you only type '/standup' and hit enter you will see the following message returned:\n\n![Status error message](images/no-status-entered.png)\n\n\n# Make this Project Better (Questions, Feedback, Pull Requests Etc.)\n\n**Help!** If you like this project and want to make it even more awesome please contribute your ideas,\ncode, etc.\n\nIf you have any questions, feedback, suggestions, etc. please submit them via issues here: https://github.com/cvitter/mattermost-standup-slash/issues\n\nIf you find errors please feel to submit pull requests. Any help in improving this resource is appreciated!\n\n# License\nThe content in this repository is Open Source material released under the MIT License. Please see the [LICENSE](LICENSE) file for full license details.\n\n# Disclaimer\n\nThe code in this repository is not sponsored or supported by Mattermost, Inc.\n\n# Authors\n* Author: [George Goldberg](https://github.com/grundleborg)\n* Author: [Craig Vitter](https://github.com/cvitter)\n\n# Contributors\n* Contributor: [Bobby Boughton](https://github.com/howaminotme)\n \nPlease submit Issues and/or Pull Requests.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcvitter%2Fmattermost-standup-slash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcvitter%2Fmattermost-standup-slash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcvitter%2Fmattermost-standup-slash/lists"}