https://github.com/computationalphysiology/slackbot

Post updates on Slack for the Computational Physiology department at Simula
https://github.com/computationalphysiology/slackbot

Last synced: 7 days ago
JSON representation

Post updates on Slack for the Computational Physiology department at Simula

• Host: GitHub
• URL: https://github.com/computationalphysiology/slackbot
• Owner: ComputationalPhysiology
• License: mit
• Created: 2019-03-21T12:56:37.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-12-09T19:28:00.000Z (about 5 years ago)
• Last Synced: 2024-12-01T19:23:22.973Z (2 months ago)
• Language: Python
• Size: 19.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ScholarBot

This is the Slack bot used to post updates about citations for the

Computational Physiology department at Simula.

The ScholarBot is highly inspired by the

[impact_bot](https://github.com/meg-simula/impact-bot), but is based

only one python (as opposed to the `impact_bot` which uses an

R-package.

## Installation

You need python >= 3.6.

Create a virtual environment

```

python3 -m virtualenv venv

source venv/bin/activate

```

install the dependencies

```

pip install -r requirements.txt

```

and install the bot

```

python setup.py install

```

## Running the bot

Now you should be able to do

```

python -m scholar_bot post_message "Hello world"

```

and it will print "Hello world" to the slack channel.

To list all other options you can type 

```

python -m scholar_bot --help

```

Please consult the [Slack API](https://api.slack.com) for how to set

up the bot. You can set you secret token either as an environment

varialbe (`SLACK_BOT_TOKEN`) or in a config file. I have mine in a

folder `~/scholarbot/config` and it looks like this:

```

[SLACK_BOT_TOKEN]

token = put your secret token here

```

I also have the `people.yml` file (which you will find in this repo as

well) in the same folder.

## Scheduling the bot

If you want your bot to e.g post a message on slack say one time evey

week, then you set up a cron job to do this. Check out [this

video](https://youtu.be/QZJ1drMQz1A) by Corey Schafer which explains

this very well.