https://github.com/city-of-helsinki/palautebot

A bot that listens to social media messages and posts feedback over Open311
https://github.com/city-of-helsinki/palautebot

Last synced: about 2 months ago
JSON representation

A bot that listens to social media messages and posts feedback over Open311

• Host: GitHub
• URL: https://github.com/city-of-helsinki/palautebot
• Owner: City-of-Helsinki
• License: mit
• Created: 2017-05-10T10:08:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T01:05:20.000Z (about 2 years ago)
• Last Synced: 2024-04-08T16:42:47.559Z (9 months ago)
• Language: Python
• Homepage:
• Size: 141 KB
• Stars: 2
• Watchers: 5
• Forks: 3
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Palaute-Bot

## Prerequisites

* PostgreSQL (>= 9.5) (a couple of older versions probably work as well)

* Python (>= 3.5)

* Twitter account and keys

* Open311 keys

## Development with Docker

1. Create `.env` environment file

2. Set at least `DEBUG=1` in this `.env` file

3. Run `docker-compose up`

4. Run migrations if needed: 

    * `docker exec palautebot-backend python manage.py migrate`

5. Create superuser if needed: 

    * `docker exec -it palautebot-backend python manage.py createsuperuser`

   

6. Run the server:

    * `docker exec -it palautebot-backend python manage.py runserver 0:8000`

## Development without Docker

### Creating a Python virtualenv

First it is highly recommended to create a Python virtualenv for the project. There are many ways to do this, using vanilla Python:

* Run `python -m venv venv`

### Python requirements

Python requirements are handled with [pip-tools](https://github.com/jazzband/pip-tools). To install it

* Run `pip install pip-tools`

#### Creating / updating Python requirements files (needed only when the requirements are changed)

* Run `pip-compile`

* For development requirements run `pip-compile requirements-dev.in`

#### Installing Python requirements

* Run `pip-sync`

* To install also development requirements instead run `pip-sync requirements.txt requirements-dev.txt`

### Database

To setup a database compatible with the default database settings:

    sudo -u postgres createuser -P -R -S palautebot  # use password `palautebot`

    sudo -u postgres createdb -O palautebot palautebot

### Running development environment

* Enable debug `echo 'DEBUG=True' >> .env`

* Run `python manage.py migrate`

* Run `python manage.py runserver` (admin UI will be accessible at http://localhost:8000/admin)

## Extra Django configuration

Environment variables are used to customize configuration in `palautebot/settings.py`. If you wish to override any

settings, you can place them in a local `.env` file which will automatically be sourced when Django imports

the settings file.

Alternatively you can create a `local_settings.py` which is executed at the end of the `palautebot/settings.py` in the

same context so that the variables defined in the settings are available.

## Running the bot

### Handling feedback from Twitter

* Run `python manage.py handle_twitter_feedback`

### Handling ticket updates in Open311

* Run `python manage.py handle_ticket_updates`

## Settings for the actual bot usage

For Twitter

* TWITTER_CONSUMER_KEY

* TWITTER_CONSUMER_SECRET

* TWITTER_ACCESS_TOKEN

* TWITTER_ACCESS_TOKEN_SECRET

* SEARCH_STRING any tweet found when searching with this string is considered feedback. tested only with hashtags

* TWITTER_USER_RATE_LIMIT_PERIOD (optional, default 60*24 = 1 day) how long period in minutes is used when checking user rate limit

* TWITTER_USER_RATE_LIMIT_AMOUNT (optional, default 5) how many tweets are allowed for a user in the above period

For Open311

* OPEN311_API_KEY

* OPEN311_API_SERVICE_CODE

* OPEN311_API_BASE_URL (in Helsinki: "https://asiointi.hel.fi/palautews/rest/v1/")

* OPEN311_FEEDBACK_URL url of a web page where a single Open311 ticket is displayed, must include {} as a placeholder for the ticket id

  (in Helsinki: "https://www.hel.fi/helsinki/fi/kaupunki-ja-hallinto/osallistu-ja-vaikuta/palaute/nayta-palaute?fid={}") 

* OPEN311_TICKET_POLLING_TIME (optional, default 24*30 = 30 days) how long tickets are polled from Open311 after their latest modification

## Getting the keys

  - **Twitter**

    - Join to Twitter developer on https://dev.twitter.com/

    - Go to My Apps

    - Register new App by filling in the form

    - Open My Apps and select the App that you added

    - Select Keys and Access Tokens tab

    - Generate new access token at the bottom of the page

    - **You need the following 4 keys**

      - Consumer Key (API Key)

      - Consumer Secret (API Secret)

      - Access Token

      - Access Token Secret

  - **Open311** **TODO**

## Issues

### Twitter

  - Applications are allowed to make maximum of 350 requests per hour.

  - Querying tweets by hashtag is limited to 100 tweets per query.

## License

[The MIT Licence](https://opensource.org/licenses/MIT)