Update README.md

Traduzione e aggiunta di informazioni al file readme

Author: MattiaFailla

README.md

@@ -1,199 +1,178 @@
-# tgbot
+# PythonItaliaTGbot
 
-A modular telegram Python bot running on python3 with an sqlalchemy database.
+Bot principale per il gruppo Telegram di [PythonItalia](https://t.me/python_ita).
 
-Originally a simple group management bot with multiple admin features, it has evolved into becoming a basis for modular
-bots aiming to provide simple plugin expansion via a simple drag and drop.
+## Che cos'è?
 
-Can be found on telegram as [Marie](https://t.me/BanhammerMarie_bot).
+Questo bot è un fork della versione base di tgBot (ex Marie). Lo sviluppo orizzontale del bot ha permesso di aggiungere funzionalità e risolvere bug presenti nel codice sorgente originale.
 
-For questions regarding creating your own bot, please head to [this chat](https://t.me/MarieOT) where you'll find a
-group of volunteers to help. We'll also help when a database schema changes, and some table column needs to be
-modified/added (this info can also be found in the commit messages)
+### Il deploy
 
-Join the [news channel](https://t.me/MarieNews) if you just want to stay in the loop about new features or
-announcements.
+Il deploy del bot può essere effettuato su Heroku (settando le variabili di ambiente) che su una VPS dedicata (preferibilmente con kernel linux > 2.6.13).
 
-Marie and I can also be found moderating the [marie support group](https://t.me/MarieSupport) aimed at providing help
-setting up Marie in your chats (_not_ for bot clones).
-Feel free to join to report bugs, and stay in the loop on the status of the bot development.
+### Configurazione del db
 
-Note to maintainers that all schema changes will be found in the commit messages, and its their responsibility to read any new commits.
+Il primo step necessario è la configurazione del database postgres.
 
-## IMPORTANT NOTICE:
+#### Installazione e configurazione di postgres
+- Installa postgres:
 
-This project is no longer under active maintenance. Occasional bug fixes may be released, but no new features are scheduled to be added.
-Users of [Marie](https://t.me/BanhammerMarie_bot) are encouraged to migrate to [Rose](https://t.me/MissRose_bot), which
-is the improved version of this project, written in goloang, with scalability in mind.
+```
+sudo apt-get update && sudo apt-get install postgresql
+```
+
+- Cambia l'utente postgres:
+
+```
+sudo su - postgres
+```
 
-## Starting the bot.
+- Crea un nuovo database utente (cambia USER con il nome dell'utente):
 
-Once you've setup your database and your configuration (see below) is complete, simply run:
+```
+createuser -P -s -e USER
+```
+Ti verrà chiesto di inserire una password.
 
-`python3 -m tg_bot`
+- Crea una nuova tabella nel db:
 
-## Setting up the bot (Read this before trying to use!):
+```
+createdb -O USER YDB_NAME
+```
+- In fine
 
-Please make sure to use python3.6, as I cannot guarantee everything will work as expected on older python versions!
-This is because markdown parsing is done by iterating through a dict, which are ordered by default in 3.6.
+```
+psql DB_NAME -h YOUR_HOST USER
+```
+A questo punto sarai in grado di connetterti al db via terminal. Di default YOUR_HOST dovrebbe essere 0.0.0.0:5432.
+Il database-uri sarà quindi:
+```
+postgres://username:pw@hostname:port/db_name
+```
 
-### Configuration
 
-There are two possible ways of configuring your bot: a config.py file, or ENV variables.
+## Configurazione
 
-The prefered version is to use a `config.py` file, as it makes it easier to see all your settings grouped together.
-This file should be placed in your `tg_bot` folder, alongside the `__main__.py` file .
-This is where your bot token will be loaded from, as well as your database URI (if you're using a database), and most of
-your other settings.
+Esistono due modi per configurare il bot: modificando il file config.py oppure impostando delle variabili d'ambiente.
 
-It is recommended to import sample_config and extend the Config class, as this will ensure your config contains all
-defaults set in the sample_config, hence making it easier to upgrade.
+Il metodo migliore è l'uso del file config.py perchè è più semplice rivedere tutte le impostazioni in un singolo file.
+Il metodo predefinito per creare il file config.py è estendere la classe di sample_config.
 
-An example `config.py` file could be:
+Un esempio di config.py potrebbe essere:
 
 ```
 from tg_bot.sample_config import Config
 
 
 class Development(Config):
-    OWNER_ID = 254318997  # my telegram ID
-    OWNER_USERNAME = "SonOfLars"  # my telegram username
+    OWNER_ID = 00000000  # my telegram ID
+    OWNER_USERNAME = "########"  # my telegram username
     API_KEY = "your bot api key"  # my api key, as provided by the botfather
     SQLALCHEMY_DATABASE_URI = 'postgresql://username:password@localhost:5432/database'  # sample db credentials
-    MESSAGE_DUMP = '-1234567890' # some group chat that your bot is a member of
+    MESSAGE_DUMP = '00000000' # some group chat that your bot is a member of
     USE_MESSAGE_DUMP = True
-    SUDO_USERS = [18673980, 83489514]  # List of id's for users which have sudo access to the bot.
+    SUDO_USERS = [0000000, 000000]  # List of id's for users which have sudo access to the bot.
     LOAD = []
     NO_LOAD = ['translation']
 ```
 
-If you can't have a config.py file (EG on heroku), it is also possible to use environment variables.
-The following env variables are supported:
-
-- `ENV`: Setting this to ANYTHING will enable env variables
+Nel caso in cui tu voglia deployare il bot su heroku dovrai impostare le ENV. Sono supportate le seguenti variabili:
 
-- `TOKEN`: Your bot token, as a string.
-- `OWNER_ID`: An integer of consisting of your owner ID
-- `OWNER_USERNAME`: Your username
 
-- `DATABASE_URL`: Your database URL
-- `MESSAGE_DUMP`: optional: a chat where your replied saved messages are stored, to stop people deleting their old
-- `LOAD`: Space separated list of modules you would like to load
-- `NO_LOAD`: Space separated list of modules you would like NOT to load
-- `WEBHOOK`: Setting this to ANYTHING will enable webhooks when in env mode
-  messages
-- `URL`: The URL your webhook should connect to (only needed for webhook mode)
 
-- `SUDO_USERS`: A space separated list of user_ids which should be considered sudo users
-- `SUPPORT_USERS`: A space separated list of user_ids which should be considered support users (can gban/ungban,
-  nothing else)
-- `WHITELIST_USERS`: A space separated list of user_ids which should be considered whitelisted - they can't be banned.
-- `DONATION_LINK`: Optional: link where you would like to receive donations.
-- `CERT_PATH`: Path to your webhook certificate
-- `PORT`: Port to use for your webhooks
-- `DEL_CMDS`: Whether to delete commands from users which don't have rights to use that command
-- `STRICT_GBAN`: Enforce gbans across new groups as well as old groups. When a gbanned user talks, he will be banned.
-- `WORKERS`: Number of threads to use. 8 is the recommended (and default) amount, but your experience may vary.
-  **Note** that going crazy with more threads wont necessarily speed up your bot, given the large amount of sql data
-  accesses, and the way python asynchronous calls work.
-- `BAN_STICKER`: Which sticker to use when banning people.
-- `ALLOW_EXCL`: Whether to allow using exclamation marks ! for commands as well as /.
+    ENV: Setting this to ANYTHING will enable env variables
 
-### Python dependencies
+    TOKEN: Your bot token, as a string.
 
-Install the necessary python dependencies by moving to the project directory and running:
+    OWNER_ID: An integer of consisting of your owner ID
 
-`pip3 install -r requirements.txt`.
+    OWNER_USERNAME: Your username
 
-This will install all necessary python packages.
+    DATABASE_URL: Your database URL
 
-### Database
+    MESSAGE_DUMP: optional: a chat where your replied saved messages are stored, to stop people deleting their old
 
-If you wish to use a database-dependent module (eg: locks, notes, userinfo, users, filters, welcomes),
-you'll need to have a database installed on your system. I use postgres, so I recommend using it for optimal compatibility.
+    LOAD: Space separated list of modules you would like to load
 
-In the case of postgres, this is how you would set up a the database on a debian/ubuntu system. Other distributions may vary.
+    NO_LOAD: Space separated list of modules you would like NOT to load
 
-- install postgresql:
+    WEBHOOK: Setting this to ANYTHING will enable webhooks when in env mode messages
 
-`sudo apt-get update && sudo apt-get install postgresql`
+    URL: The URL your webhook should connect to (only needed for webhook mode)
 
-- change to the postgres user:
+    SUDO_USERS: A space separated list of user_ids which should be considered sudo users
 
-`sudo su - postgres`
+    SUPPORT_USERS: A space separated list of user_ids which should be considered support users (can gban/ungban, nothing else)
 
-- create a new database user (change YOUR_USER appropriately):
+    WHITELIST_USERS: A space separated list of user_ids which should be considered whitelisted - they can't be banned.
 
-`createuser -P -s -e YOUR_USER`
+    DONATION_LINK: Optional: link where you would like to receive donations.
 
-This will be followed by you needing to input your password.
+    CERT_PATH: Path to your webhook certificate
 
-- create a new database table:
+    PORT: Port to use for your webhooks
 
-`createdb -O YOUR_USER YOUR_DB_NAME`
+    DEL_CMDS: Whether to delete commands from users which don't have rights to use that command
 
-Change YOUR_USER and YOUR_DB_NAME appropriately.
+    STRICT_GBAN: Enforce gbans across new groups as well as old groups. When a gbanned user talks, he will be banned.
 
-- finally:
+    WORKERS: Number of threads to use. 8 is the recommended (and default) amount, but your experience may vary. Note that going crazy with more threads wont necessarily speed up your bot, given the large amount of sql data accesses, and the way python asynchronous calls work.
 
-`psql YOUR_DB_NAME -h YOUR_HOST YOUR_USER`
+    BAN_STICKER: Which sticker to use when banning people.
 
-This will allow you to connect to your database via your terminal.
-By default, YOUR_HOST should be 0.0.0.0:5432.
+    ALLOW_EXCL: Whether to allow using exclamation marks ! for commands as well as /.
 
-You should now be able to build your database URI. This will be:
 
-`sqldbtype://username:pw@hostname:port/db_name`
 
-Replace sqldbtype with whichever db youre using (eg postgres, mysql, sqllite, etc)
-repeat for your username, password, hostname (localhost?), port (5432?), and db name.
+### Dependency
 
-## Modules
+Installa le dependency con questo comando:
 
-### Setting load order.
-
-The module load order can be changed via the `LOAD` and `NO_LOAD` configuration settings.
-These should both represent lists.
+```
+pip3 install -r requirements.txt
+```
 
-If `LOAD` is an empty list, all modules in `modules/` will be selected for loading by default.
+## Moduli
 
-If `NO_LOAD` is not present, or is an empty list, all modules selected for loading will be loaded.
+#### Imposta l'ordine di caricamento dei moduli
 
-If a module is in both `LOAD` and `NO_LOAD`, the module will not be loaded - `NO_LOAD` takes priority.
+L'ordine di caricamento in memoria dei moduli può essere opportunamente modificato tramite l'uso di LOAD e NO_LOAD.
 
-### Creating your own modules.
+Nota: NO_LOAD è prioritario rispetto a LOAD
 
-Creating a module has been simplified as much as possible - but do not hesitate to suggest further simplification.
+## Avviare il bot con docker
 
-All that is needed is that your .py file be in the modules folder.
+#### Requisiti
+- docker
+- docker-compose
 
-To add commands, make sure to import the dispatcher via
+#### Avvio
+- Crea un file .env usando docker/dev/config.sample come template e salvandola in docker/dev/
+- Assicurati di essere nella root del progetto e inserisci il seguente comando: 
+```
+docker-compose -f docker/dev/docker-compose.yml up -d
+```
 
-`from tg_bot import dispatcher`.
+## Costruito con
 
-You can then add commands using the usual
+* [tgbot](https://github.com/PaulSonOfLars/tgbot) - Bot modulare scritto in Python3
+* [Trevis CI](https://travis-ci.com) - Deploy in production
+* [Docker](https://www.docker.com/) - Used to generate RSS Feeds
 
-`dispatcher.add_handler()`.
+## Come contribuire
 
-Assigning the `__help__` variable to a string describing this modules' available
-commands will allow the bot to load it and add the documentation for
-your module to the `/help` command. Setting the `__mod_name__` variable will also allow you to use a nicer, user
-friendly name for a module.
+Per favore leggi [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) per avere dettagli sulle regole
+per contribuire e come effettuare una pull-request.
 
-The `__migrate__()` function is used for migrating chats - when a chat is upgraded to a supergroup, the ID changes, so
-it is necessary to migrate it in the db.
+## Versioning
 
-The `__stats__()` function is for retrieving module statistics, eg number of users, number of chats. This is accessed
-through the `/stats` command, which is only available to the bot owner.
+Noi usiamo [SemVer](http://semver.org/) per il versioning, sincronizzato con i tag in production di GH.
 
-### Running dev with docker
+## Autori
 
-#### Requirements
+Controlla la lista di [contributors](https://github.com/Kavuti/python-italy-telegram-bot/graphs/contributors) che hanno reso questo progetto grande.
 
-- docker
-- docker-compose
+## License
 
-#### Up & Running
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
 
-- Create .env file by using docker/dev/config.sample as template and save it into docker/dev/
-- Be sure to be at project root directory and run `docker-compose -f docker/dev/docker-compose.yml up -d`