Skip to content

Commit

Permalink
Create requirements and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Steffo99 committed May 3, 2018
1 parent 3c9874f commit c01158d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
@@ -1,2 +1,27 @@
# greed
A customizable Telegram shop bot
A customizable Telegram shop bot, developed for the High School oral exam

![](https://img.shields.io/badge/version-alpha-blue.svg)

## Requirements
* Python 3.6 (or higher)
* The packages specified in `requirements.txt` (install with `pip install -r requirements.txt`)
* A Internet connection
* A Telegram bot token (obtainable at [@Botfather](https://t.me/Botfather))
* A payment provider token (obtainable by [connecting Stripe with your bot](https://t.me/Botfather))
* _Optional: a [sentry.io](https://sentry.io) token_

## Installation
1. Download the project files through `git clone https://github.com/Steffo99/greed.git` or [this link](https://github.com/Steffo99/greed/archive/master.zip).
2. Install the project requirements with `pip install -r requirements.txt`
3. Run `python -OO core.py` to generate the configuration file.
4. Open the config folder and edit the `config.ini` file following the contained instructions.
Ensure the `is_template` field is set to `no`.
5. _Optional: customize the `strings.py` file_
6. Run `python -OO core.py` again to run the bot.
7. Open Telegram, and send a `/start` command to your bot to be promoted to administrator.

## Usage
All the bot features are available through Telegram.
As the administrator, you can add new products, check the placed orders, create new transactions and generate .csv log files.
Users will be able to add credit to their wallet, place orders and contact you in case they require assistance.
4 changes: 4 additions & 0 deletions requirements.txt
@@ -0,0 +1,4 @@
python-telegram-bot
sqlalchemy
requests
raven

0 comments on commit c01158d

Please sign in to comment.