steffo/greed
steffo/greed
1
Fork 0
mirror of https://github.com/Steffo99/greed.git synced 2024-11-25 07:14:18 +00:00
Code Activity
greed/README.md
Stefano Pigozzi 2e142d6702
Update README.md
2019-10-20 19:14:14 +02:00

1.8 KiB
Raw Blame History

greed

A customizable Telegram shop bot, developed as a project for the final exam.

Requirements

  • Python 3.6 (or higher)
  • The packages specified in requirements.txt (install with pip install -r requirements.txt)
  • An Internet connection
  • A Telegram bot token (obtainable at @Botfather)
  • A payment provider token (obtainable by connecting a provider with your bot)
  • Optional: a sentry.io token

Installation

  1. Download the project files through git clone https://github.com/Steffo99/greed.git or this link.
  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. Run python -OO database.py to generate the database tables.
  6. Optional: customize the strings.py file
  7. Run python -OO core.py again to run the bot.
  8. 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.

Documentation

greed currently does not have a documentation page, but you can try to read the paper (in Italian) I wrote for my final Scuola Superiore exam about it.