Skip to main content

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

Project description

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

You may choose between method 1 (pip) and method 2 (git).

  1. Using pip
    • Install ciclopibot
    pip install ciclopibot
    
    • Run ciclopibot as module
    python -m ciclopibot -h  # Get help 
    python -m ciclopibot <your_token_here>
    
  2. Using git
    • 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ciclopibot-1.2.6.tar.gz (19.8 kB view hashes)

Uploaded Source

Built Distribution

ciclopibot-1.2.6-py3-none-any.whl (19.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page