user guide wip #223

MANIFEST.in

@@ -9,6 +9,10 @@ recursive-include th_evernote *.html
 recursive-include th_evernote/templates *
 recursive-include th_evernote/migrations *
 
+recursive-include th_github *.html
+recursive-include th_github/templates *
+recursive-include th_github/migrations *
+
 recursive-include th_instapush *.html
 recursive-include th_instapush/templates *
 recursive-include th_instapush/migrations *
@@ -29,9 +33,21 @@ recursive-include th_pushbullet *.html
 recursive-include th_pushbullet/templates *
 recursive-include th_pushbullet/migrations *
 
+recursive-include th_reddit *.html
+recursive-include th_reddit/templates *
+recursive-include th_reddit/migrations *
+
 recursive-include th_rss *.html
 recursive-include th_rss/templates *
 
+recursive-include th_slack *.html
+recursive-include th_slack/templates *
+recursive-include th_slack/migrations *
+
+recursive-include th_taiga *.html
+recursive-include th_taiga/templates *
+recursive-include th_taiga/migrations *
+
 recursive-include th_todoist *.html
 recursive-include th_todoist/templates *
 recursive-include th_todoist/migrations *
@@ -40,6 +56,10 @@ recursive-include th_trello *.html
 recursive-include th_trello/templates *
 recursive-include th_trello/migrations *
 
+recursive-include th_tumblr *.html
+recursive-include th_tumblr/templates *
+recursive-include th_tumblr/migrations *
+
 recursive-include th_twitter *.html
 recursive-include th_twitter/templates *
 recursive-include th_twitter/migrations *

docs/installation_guide/reddit.rst

@@ -0,0 +1,71 @@
+Reddit
+========
+
+Service Description:
+--------------------
+
+The front page of internet
+
+User Guide
+----------
+
+Activation of the service
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+From the page http://127.0.0.1:8000/th/service/add/
+
+.. image:: https://raw.githubusercontent.com/foxmask/django-th/master/docs/installation_guide/public_service_wallabag_add.png
+   :alt: My Activated Services
+
+then in the form, select Reddit in the dropdown box and press "Activate it"
+
+Defining a trigger
+~~~~~~~~~~~~~~~~~~
+
+with Reddit as consumer, when another service is used as a provider
+
+.. image:: https://raw.githubusercontent.com/foxmask/django-th/master/docs/installation_guide/reddit_consumer_step3.png
+    :alt: reddit step 3
+
+.. image:: https://raw.githubusercontent.com/foxmask/django-th/master/docs/installation_guide/reddit_consumer_step4.png
+    :alt: reddit step 4
+
+with Reddit as provider, when another service is used as a consumer
+
+.. image:: https://raw.githubusercontent.com/foxmask/django-th/master/docs/installation_guide/reddit_provider_step1.png
+    :alt: reddit step 1
+
+.. image:: https://raw.githubusercontent.com/foxmask/django-th/master/docs/installation_guide/reddit_provider_step2.png
+    :alt: reddit step 2
+
+Installation Guide
+------------------
+
+Requesting a key
+~~~~~~~~~~~~~~~~
+
+On https://dev.evernote.com/ at the top right of the page, click on 'get an api key'.
+
+Fill the form and get the informations that you will need to provide in the next paragraph
+
+
+The service keys
+~~~~~~~~~~~~~~~~
+
+Here are the modifications of .env file you will need to make to be able to use your credentials with Reddit
+
+.. code-block:: python
+
+    TH_REDDIT_CLIENT_ID='your consumer key'
+    TH_REDDIT_CLIENT_SECRET='your consumer secret'
+    TH_REDDIT_USER_AGENT=TriggerHappy:1.5.0 (by /u/foxmask2)
+
+
+Configuration from the Admin panel
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+http://127.0.0.1:8000/admin/django_th/servicesactivated/
+
+.. image:: https://raw.githubusercontent.com/foxmask/django-th/master/docs/installation_guide/service_reddit.png
+    :target: https://reddit.com/
+    :alt: Reddit

docs/installation_guide/services.rst

@@ -69,6 +69,7 @@ Here are the services that will follow almost the same previous path
    pelican
    pocket
    pushbullet
+   reddit
    rss
    slack
    taiga