Skip to content

Commit

Permalink
docs: Update documentation (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
juhosyrjanen authored Dec 19, 2022
1 parent 73324e7 commit 9c306a0
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,25 @@

> Reporting the important things to the masses
Pirkkabot innocently scans K-Ruoka webstore for Pirkka III -beer's price daily (Kesko pls don't block, 1 page load per day only!). As of release v2.0 Pirkkabot is utilising PirkkaAPI, ChromeEngine & Selenium are deprecated.
Pirkkabot innocently scans K-Ruoka webstore for Pirkka III -beer's price daily (Kesko pls don't block, 1 page load per day only!).

## Technologies used

- Good old Bash and RegEx.
- Docker
- Python
- Tweepy
- SQLite3

## Dockerfile

Docker image is based on ``python:3.7`` base image.

# Run Pirkkabot

To run Pirkkabot, populate secrets, mount DB and run:
To run Pirkkabot, populate secrets, run:

```bash
docker run --mount type=bind,source="$(pwd)"/db,target=/app/db pirkkabot
```shell
cd pirkkabot
mkdir db && touch db/pirkka_price.db
python3 ./tweet.py
```

### PirkkaDB

As of v1.0.1 Pirkka III-Olut daily price is saved to an SQLite database.
Database backups are handled at server backend to off-site NAS server.
As of v1.0.1 Pirkka III-Olut daily price is saved to an SQLite database.
Database backups are handled at the server backend to the off-site NAS server.

0 comments on commit 9c306a0

Please sign in to comment.