django-th 0.11.0

TH_SERVICES

TH_SERVICES is a list of the supported services

TH_SERVICES = (
    # comment the line to disable the service you dont want
    'th_rss.my_rss.ServiceRss',
    'th_pocket.my_pocket.ServicePocket',
    'th_evernote.my_evernote.ServiceEvernote',
    'th_readability.my_readability.ServiceReadability',
    'th_trello.my_trello.ServiceTrello',
    'th_twitter.my_twitter.ServiceTwitter',
)

TH_EVERNOTE

TH_EVERNOTE is the settings you will need to be able to add/read data in/from Evernote.

To be able to use Evernote see official FAQ :

• How do I create an API key?

• How do I copy my API key from Sandbox to www (production)?

TH_EVERNOTE = {
    'sandbox': True, #set to False in production - to be able to use it with trigger happy of course ;)
    'consumer_key': 'abcdefghijklmnopqrstuvwxyz',
    'consumer_secret': 'abcdefghijklmnopqrstuvwxyz',
}

TH_POCKET

TH_POCKET is the settings you will need to be able to add/read data in/from Pocket.

To be able to use Pocket :

• you will need to grad the pocket consumer key by creating a new application with the rights access as below

• then copy the “consumer key” of your application to the settings.py

TH_POCKET = {
    'consumer_key': 'abcdefghijklmnopqrstuvwxyz',
}

TH_READABILITY

TH_READABILITY is the settings you will need, to be able to add/read data in/from readability Service.

To be able to use readability :

• you will need to grad the readability keys

• create a new application at readability website, then

• copy the “keys & secret” of your application to the settings.py

TH_READABILITY = {
    'consumer_key': 'abcdefghijklmnopqrstuvwxyz',
    'consumer_secret': 'abcdefghijklmnopqrstuvwxyz',
}

TH_TRELLO

TH_TRELLO is the settings you will need to be able to add/read data in/from Trello.

To be able to use Trello:

• you will need to create an account at https://trello.com/docs/

• then create an application and adding to the URL request “scope=read,write”

TH_TRELLO = {
    'consumer_key': 'abcdefghijklmnopqrstuvwxyz',
    'consumer_secret': 'abcdefghijklmnopqrstuvwxyz',
}

TH_TWITTER

TH_TWITTER is the settings you will need to be able to add/read data in/from Twitter.

To be able to use Twitter:

• you will need to create an account at https://apps.twitter.com/

• then create an application

• then on the Application Settings tab set the rights to “read and write permission”

• then on Keys tab copy the information and fill the settings.py with them

TH_TWITTER = {
    'consumer_key': 'abcdefghijklmnopqrstuvwxyz',
    'consumer_secret': 'abcdefghijklmnopqrstuvwxyz',
}

CACHE

For each TriggerHappy component, define one cache like below

CACHES = {
    # Evernote Cache
    'th_evernote':
    {
        'TIMEOUT': 500,
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "127.0.0.1:6379",
        "OPTIONS": {
            "DB": 1,
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    },
    # Pocket Cache
    'th_pocket':
    {
        'TIMEOUT': 500,
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "127.0.0.1:6379",
        "OPTIONS": {
            "DB": 2,
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    },
    # RSS Cache
    'th_rss':
    {
        'TIMEOUT': 500,
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "127.0.0.1:6379",
        "OPTIONS": {
            "DB": 3,
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    },
    # Readability
    'th_readability':
    {
        'TIMEOUT': 500,
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "127.0.0.1:6379",
        "OPTIONS": {
            "DB": 4,
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    },
    # Trello Cache
    'th_trello':
    {
        'TIMEOUT': 500,
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "127.0.0.1:6379",
        "OPTIONS": {
            "DB": 5,
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    },
    # Twitter Cache
    'th_twitter':
    {
        'TIMEOUT': 500,
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "127.0.0.1:6379",
        "OPTIONS": {
            "DB": 6,
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    },
}

CELERY

Celery will handle tasks itself to populate the cache from provider services and then exploit it to publish the data to the expected consumer services

• From Settings

Define the broker then the scheduler

from celery.schedules import crontab
BROKER_URL = 'redis://localhost:6379/0'

CELERYBEAT_SCHEDULE = {
    'read-data': {
        'task': 'django_th.tasks.read_data',
        'schedule': crontab(minute='27,54'),
    },
    'publish-data': {
        'task': 'django_th.tasks.publish_data',
        'schedule': crontab(minute='59'),
    },
}

• From SUPERVISORD

[program:django_th_worker]
user = foxmask
directory=/home/projects/trigger-happy/th
command=/home/projects/trigger-happy/bin/celery -A django_th worker --autoscale=10,3 -l info
autostart=true
autorestart=true
redirect_stderr=true
stdout_logfile=/home/projects/trigger-happy/logs/trigger-happy.log
stderr_logfile=/home/projects/trigger-happy/logs/trigger-happy-err.log

[program:django_th_beat]
user = foxmask
directory=/home/projects/trigger-happy/th
command=/home/projects/trigger-happy/bin/celery -A django_th beat -l info
autostart=true
autorestart=true
redirect_stderr=true
stdout_logfile=/home/projects/trigger-happy/logs/trigger-happy.log
stderr_logfile=/home/projects/trigger-happy/logs/trigger-happy-err.log

REDISBOARD

# REDISBOARD
REDISBOARD_DETAIL_FILTERS = ['.*']

HAYSTACK

if you plan to use the search feature, put the engine of your choice, for example :

# needed to th_search and haystack
HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
        'URL': 'http://127.0.0.1:9200/',
        'INDEX_NAME': 'haystack',
    },
}