|
||
---|---|---|
config | ||
strings | ||
.gitignore | ||
configloader.py | ||
CONTRIBUTING.md | ||
core.py | ||
database.py | ||
LICENSE.txt | ||
localization.py | ||
README.md | ||
requirements.txt | ||
utils.py | ||
worker.py |
greed
A customizable, multilanguage Telegram shop bot with Telegram Payments support!
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 git client
- Optional: a sentry.io token
Installation
- Download the project files through
git clone https://github.com/Steffo99/greed.git
(recommended) or this link. - Install the project requirements with
pip install -r requirements.txt
- Optional: run
pip install coloredlogs
to have colored logging output. - 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.
Updating
Through git
If you downloaded greed
through git
, you can update it by running:
git stash
git pull
git stash pop
By redownloading the zip file
If you downloaded greed
through the zip archive, you can update it by redownloading the latest version and by moving your config.ini
and database.sqlite
(if applicable) files to the new folder.
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.
Help!
If you find a bug, have an idea for a new feature or just require help with greed
, please post an issue on GitHub, or, if GitHub is blocked in your country, join the Telegram group and send a message there.
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.