Queer European MD passionate about IT

Telegram bot based on `davtelepot` which provides information about CicloPi, the public bike-sharing service in Pisa.

Davte 60034cf30b Ignore pictures folder (symbolic link) 4 years ago
ciclopibot 60034cf30b Ignore pictures folder (symbolic link) 4 years ago
.gitignore 60034cf30b Ignore pictures folder (symbolic link) 4 years ago
LICENSE 9cd328e2f2 Repo initialization 4 years ago
MANIFEST.in 60034cf30b Ignore pictures folder (symbolic link) 4 years ago
README.md 9cd328e2f2 Repo initialization 4 years ago
ciclopibot.service 83d0f2ebe2 Systemd service 4 years ago
generate_documentation.sh af37852f58 Bash script to generate documentation 4 years ago
install.sh c0de346bdf Bash scripts to configure develop environment and run main script 4 years ago
merge_and_push.sh 951d7d6faa Script to merge and push to gogs and github 4 years ago
requirements.txt 9cd328e2f2 Repo initialization 4 years ago
run_me.sh c0de346bdf Bash scripts to configure develop environment and run main script 4 years ago
setup.py aee0c692ef First release 4 years ago
update_package.sh aee0c692ef First release 4 years ago

README.md

CicloPiBot

@CicloPiBot is a Telegram bot based on davtelepot which provides information about CicloPi, the public bike-sharing service in Pisa.

Usage

Client side

Send /start @CicloPiBot, all you need is a Telegram account.

Commands

  • /start the bot
  • Ask for /help for further information
  • Ask for /ciclopi information

"Server" side

  • Clone this repository

    git clone ssh://git@gogs.davte.it:8445/Davte/ciclopibot.git
    # git clone https://gogs.davte.it/Davte/ciclopibot.git
    # git clone git@github.com:Davte/ciclopibot.git
    # git clone https://github.com/Davte/ciclopibot.git
    
  • Run install.sh: it will help you perform the following operations.

    • Put a Telegram bot token in gitignored data/passwords.py module.
    • To get a token, ask @BotFather.
    • The bot whose token you use will act as @CicloPiBot as long as you run the script.
    • Create a python3.5+ virtual environment and install requirements.
    • Specify python_virtual_environment and python_script variables in my_config.sh
  • Run run_me.sh

    bash run_me.sh;
    
  • You may edit the file and test your code with your bot.

  • Should you be satisfied of your edits enough, you may fork this repository and open a pull request.

Credits

  • Davte is the creator and the main author of this repository.
  • All data are obtained from CicloPi website and are meant to help users save time when using their service. Misuse is discouraged.
  • Minala inspired the idea and gave a first version of this service many years ago with a different implementation.