mirror of
https://github.com/Steffo99/greed.git
synced 2024-11-29 00:54:18 +00:00
2.2 KiB
2.2 KiB
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 withpip 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
- Download the project files through
git clone https://github.com/Steffo99/greed.git
or this link. - Install the project requirements with
pip install -r requirements.txt
- Run
python -OO core.py
to generate the configuration file. - Open the config folder and edit the
config.ini
file following the contained instructions.
Ensure theis_template
field is set tono
. - Run
python -OO database.py
to generate the database tables. - Optional: customize the
strings.py
file - Run
python -OO core.py
again to run the bot. - 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.
Forks
Please note that @Steffo99, the developer of
greed
, does not endorse any of these forks.
Bitcoin - Blockonomics
DarrenWestwood is currently maintaining a greed
fork with Bitcoin support through Blockonomics.