Giter Club home page Giter Club logo

callmebot's Introduction

CallMeBot Python Client

This module offers a simple client to the CallMeBot service to send Whatsapp, Telegram and Signal text messages.

Installation

Install with pip3 install callmebot.

Usage

  1. You should first configure CallMeBot as explained at https://www.callmebot.com/

  2. You should then configure your keys. There are two ways to do it:

    • Store them in the ~/.secrets/secrets.yml file in a callmebot entry for the text services you wish to use:

      callmebot:
          whatsapp_phone: '555123123123'
          whatsapp_apikey: '999999'
          signal_phone: '555123123123'
          signal_apikey: '999999'
          telegram_username: 'username'
      
    • Set environment variables for the text services you wish to use:

      export CALLMEBOT_WHATSAPP_PHONE='555123123123'
      export CALLMEBOT_WHATSAPP_APIKEY='999999'
      export CALLMEBOT_SIGNAL_PHONE='555123123123'
      export CALLMEBOT_SIGNAL_APIKEY='999999'
      export CALLMEBOT_TELEGRAM_USERNAME='username'

    The tool uses the ~/.secrets/secrets.yml file first and the environment variables as fallback. If you do not configure some text service, you cannot use it.

  3. Call the desired function (whatsapp, signal, telegram|) with the message to be sent:

    import callmebot
    
    callmebot.whatsapp('This is an important message!\nRegards.')
  4. Or, use the callmebot command line:

    callmebot whatsapp 'This is an important message!\nRegards.'

    Get help with --help:

    callmebot --help

Credits

License

Apache License 2.0

callmebot's People

Contributors

jordi-petit avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.