greed/README.md

# greed

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

![](https://img.shields.io/badge/version-beta-blue.svg) ![](https://img.shields.io/badge/maintenance-passively--maintained-yellowgreen)

## 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](https://t.me/Botfather))
* A payment provider token (obtainable by [connecting a provider 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. 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](https://docs.google.com/document/d/1f4MKVr0B7RSQfWTSa_6ZO0LM4nPpky_GX_qdls3EHtQ/edit?usp=sharing) (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](https://github.com/DarrenWestwood) is currently maintaining a [`greed`](https://github.com/DarrenWestwood/greed) fork with **Bitcoin support** through [Blockonomics](https://www.blockonomics.co/).
Initial commit 2017-11-29 10:34:11 +00:00			`# greed`
Improve README 2020-03-01 22:51:35 +00:00
README update 2018-05-03 08:39:25 +00:00			`A customizable Telegram shop bot, developed as a project for the final exam.`
Create requirements and update README 2018-05-03 06:48:31 +00:00
Improve README 2020-03-01 22:51:35 +00:00			`![](https://img.shields.io/badge/version-beta-blue.svg) ![](https://img.shields.io/badge/maintenance-passively--maintained-yellowgreen)`
Create requirements and update README 2018-05-03 06:48:31 +00:00
			`## Requirements`
Improve README 2020-03-01 22:51:35 +00:00
Create requirements and update README 2018-05-03 06:48:31 +00:00			`* Python 3.6 (or higher)`
			* The packages specified in `requirements.txt` (install with `pip install -r requirements.txt`)
Fixed some typos in the README file 2018-07-01 14:57:27 +00:00			`* An Internet connection`
Create requirements and update README 2018-05-03 06:48:31 +00:00			`* A Telegram bot token (obtainable at [@Botfather](https://t.me/Botfather))`
Fixed some typos in the README file 2018-07-01 14:57:27 +00:00			`* A payment provider token (obtainable by [connecting a provider with your bot](https://t.me/Botfather))`
Create requirements and update README 2018-05-03 06:48:31 +00:00			`* _Optional: a [sentry.io](https://sentry.io) token_`

			`## Installation`
Improve README 2020-03-01 22:51:35 +00:00
Create requirements and update README 2018-05-03 06:48:31 +00:00			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`.
Added possible fix to a common problem 2018-09-24 15:20:40 +00:00			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.
Create requirements and update README 2018-05-03 06:48:31 +00:00
			`## Usage`
Improve README 2020-03-01 22:51:35 +00:00
			`All the bot features are available through Telegram.`
Create requirements and update README 2018-05-03 06:48:31 +00:00			`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.`
Update README.md 2019-10-20 17:14:14 +00:00
			`## Documentation`

			`greed` currently does not have a documentation page, but you can try to read the [paper](https://docs.google.com/document/d/1f4MKVr0B7RSQfWTSa_6ZO0LM4nPpky_GX_qdls3EHtQ/edit?usp=sharing) (in Italian) I wrote for my final Scuola Superiore exam about it.
Improve README 2020-03-01 22:51:35 +00:00
			`## Forks`

			> Please note that @Steffo99, the developer of `greed`, does not endorse any of these forks.

			`### Bitcoin - Blockonomics`

			[DarrenWestwood](https://github.com/DarrenWestwood) is currently maintaining a [`greed`](https://github.com/DarrenWestwood/greed) fork with Bitcoin support through [Blockonomics](https://www.blockonomics.co/).