Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Chatwork integration for Django

Project description

Travis CI COVERALLS Code Climate Issue Count LICENSE MIT

django-chatwork is Chatwork integration for Django.

Requirement

  • Python >= 3.5
  • Django >= 1.11

Quick start

  1. Install by pip

    # instal from PyPI
    pip install django-chatwork
    
    # install from github master branch
    pip install -U https://github.com/kacchan822/django-chatwork/archive/master.tar.gz
    
  2. Add “chatwork” to INSTALLED_APPS

    INSTALLED_APPS = [
        ...
        'chatwork',
        ...
    ]
    
  3. Set Valuse in settings

    # You have to set this
    CHATWORK_API_TOKEN = 'youre api token'
    
    # You don't have to usually set this
    CHATWORK_API_ENDPOINT_BASE =  'https://api.chatwork.com/v2' # default
    CHATWORK_API_BACKEND = 'chatwork.backends.http.UrllibBackend' # default if DEBUG = False
                                                                  # if DEBUG = True, the value set 'chatwork.backends.dummy.DummyBackend' as default
    CHATWORK_API_FAIL_SILENTLY = None   # default
    
  4. Usage

    from chatwork import send_message
    
    ...
    
    # send message to room_id = 123456
    send_chatwork('message text hear', 123456)
    
    # send message to room_id = 123456 with [To:] for all members
    send_chatwork('message text hear', 123456, to_all=True)
    
    # send message to room_id = 123456 with INFO format
    # INFO format contains [To:] for all users
    send_chatwork('message text hear', 123456, title='info title')
    
    ...
    

Acknowledgements

Project details


Download files

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

Files for django-chatwork, version 0.5.0
Filename, size File type Python version Upload date Hashes
Filename, size django_chatwork-0.5.0-py3-none-any.whl (18.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size django-chatwork-0.5.0.tar.gz (10.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page