add wallabag doc

README.rst

@@ -129,6 +129,9 @@ for pelican support
 
 * `awesome-slugify <https://pypi.python.org/pypi/awesome-slugify>`_ == 1.6.5
 
+for wallabag support
+
+* `wallabag_api <https://pypi.python.org/pypi/wallabag_api>`_ == 1.0.0
 
 and finally :
 

django_th/settings.py

@@ -288,16 +288,16 @@
             "CLIENT_CLASS": "django_redis.client.DefaultClient",
         }
     },
-    # Pelican
+    # Wallabag
     'th_wallabag':
-        {
+    {
             'TIMEOUT': 3600,
             "BACKEND": "django_redis.cache.RedisCache",
             "LOCATION": "redis://127.0.0.1:6379/9",
             "OPTIONS": {
                 "CLIENT_CLASS": "django_redis.client.DefaultClient",
             }
-        },
+    },
     'redis-cache':
     {
         'TIMEOUT': 3600,

docs/configuration.rst

@@ -56,6 +56,7 @@ add the module django_th, and its friends, to the INSTALLED_APPS
         # 'haystack',  # mandatory  if you plan to use th_search
         # 'th_search', # then follow instructions from http://django-haystack.readthedocs.org/
         # 'th_pelican',
+        # 'th_wallabag',
 
     )
 
@@ -78,6 +79,7 @@ TH_SERVICES is a list of the services, like for example,
         # 'th_trello.my_trello.ServiceTrello',
         # 'th_twitter.my_twitter.ServiceTwitter',
         # 'th_github.my_github.ServiceGithub',
+        # 'th_wallabag.my_wallabag.ServiceWallabag',
     )
 
 do not forget to uncomment one of the line to enable another service, or the application wont work.
@@ -296,6 +298,17 @@ For each TriggerHappy component, define one cache like below
                 "CLIENT_CLASS": "django_redis.client.DefaultClient",
             }
         },
+        # Wallabag
+        'th_wallabag':
+        {
+                'TIMEOUT': 3600,
+                "BACKEND": "django_redis.cache.RedisCache",
+                "LOCATION": "redis://127.0.0.1:6379/9",
+                "OPTIONS": {
+                    "CLIENT_CLASS": "django_redis.client.DefaultClient",
+                }
+        },
+
     }
 
 in the settings, 'default' may already exist in your settings.py, so dont use it, otherwise, if it doesnt, django will complain, so add it.

docs/evernote.rst

@@ -87,6 +87,6 @@ from http://yourdomain.com/admin/django_th/servicesactivated/add/
 
 * Select "Evernote",
 * Set the Status to "Enabled"
-* Check Auth Required: this will permit to redirect to the user (or you) to Evernote to ask to confirm the access to hist/your Evernote account
+* Check Auth Required: this will permit to redirect to the user (or you) to Evernote to ask to confirm the access to his/your Evernote account
 * Fill a description
 

docs/github.rst

@@ -88,6 +88,6 @@ from http://yourdomain.com/admin/django_th/servicesactivated/add/
 
 * Select "GitHub",
 * Set the Status to "Enabled"
-* Check Auth Required: this will permit to redirect to the user (or you) to GitHub to ask to confirm the access to hist/your GitHub account
+* Check Auth Required: this will permit to redirect to the user (or you) to GitHub to ask to confirm the access to his/your GitHub account
 * Fill a description
 

docs/installation.rst

@@ -153,3 +153,6 @@ for pelican support
 
 * `awesome-slugify <https://pypi.python.org/pypi/awesome-slugify>`_ == 1.6.5
 
+for wallabag support
+
+* `wallabag_api <https://pypi.python.org/pypi/wallabag_api>`_ == 1.0.0

docs/pocket.rst

@@ -86,6 +86,6 @@ from http://yourdomain.com/admin/django_th/servicesactivated/add/
 
 * Select "Pocket",
 * Set the Status to "Enabled"
-* Check Auth Required: this will permit to redirect to the user (or you) to Pocket to ask to confirm the access to hist/your Pocket account
+* Check Auth Required: this will permit to redirect to the user (or you) to Pocket to ask to confirm the access to his/your Pocket account
 * Fill a description
 

docs/readability.rst

@@ -88,7 +88,7 @@ from http://yourdomain.com/admin/django_th/servicesactivated/add/
 
 * Select "Readability",
 * Set the Status to "Enabled"
-* Check Auth Required: this will permit to redirect to the user (or you) to Readability to ask to confirm the access to hist/your Readability account
+* Check Auth Required: this will permit to redirect to the user (or you) to Readability to ask to confirm the access to his/your Readability account
 * Fill a description
 
 

docs/services.rst

@@ -25,5 +25,6 @@ For all the services, the installation is the same :
    search
    trello
    twitter
+   wallabag
 
 

docs/trello.rst

@@ -87,7 +87,7 @@ from http://yourdomain.com/admin/django_th/servicesactivated/add/
 
 * Select "Trello",
 * Set the Status to "Enabled"
-* Check Auth Required: this will permit to redirect to the user (or you) to Trello to ask to confirm the access to hist/your Trello account
+* Check Auth Required: this will permit to redirect to the user (or you) to Trello to ask to confirm the access to his/your Trello account
 * Fill a description
 
 

docs/twitter.rst

@@ -88,5 +88,5 @@ from http://yourdomain.com/admin/django_th/servicesactivated/add/
 
 * Select "Twitter",
 * Set the Status to "Enabled"
-* Check Auth Required: this will permit to redirect to the user (or you) to Twitter to ask to confirm the access to hist/your Twitter account
+* Check Auth Required: this will permit to redirect to the user (or you) to Twitter to ask to confirm the access to his/your Twitter account
 * Fill a description

docs/usage.rst

@@ -5,7 +5,9 @@ Usage
 Activating services :
 ---------------------
 
-The user activates the service for their own need. If the service requires an external authentication, he will be redirected to the service which will ask him the authorization to acces the user's account. Once it's done, goes back to django-trigger-happy to finish and record the "auth token".
+The user activates the service for their own need. If the service requires an external authentication,
+he will be redirected to the service which will ask him the authorization to acces the user's account.
+Once it's done, goes back to django-trigger-happy to finish and record the "auth token".
 
 Using the activated services :
 ------------------------------
@@ -22,4 +24,4 @@ For example :
 Fire the Triggers :
 ===================
 
-Grabbing data and publishing data are done by Python-RQ each 12min and 15min.
+Grabbing data and publishing data are done each 12min and 15min from your crontab

docs/wallabag.rst

@@ -0,0 +1,96 @@
+Wallabag
+========
+
+Service Description:
+--------------------
+
+a self hostable application for saving web pages
+
+modifications of settings.py
+----------------------------
+
+1) INSTALLED_APPS :
+
+.. code-block:: python
+
+    INSTALLED_APPS = (
+        'th_wallabag',
+    )
+
+2) Cache :
+
+After the default cache add :
+
+.. code-block:: python
+
+    CACHES = {
+        'default':
+        {
+            'BACKEND': 'django.core.cache.backends.filebased.FileBasedCache',
+            'LOCATION': BASE_DIR + '/cache/',
+            'TIMEOUT': 600,
+            'OPTIONS': {
+                'MAX_ENTRIES': 1000
+            }
+        },
+        # Wallabag Cache
+        'th_wallabag':
+        {
+            'TIMEOUT': 500,
+            "BACKEND": "django_redis.cache.RedisCache",
+            "LOCATION": "redis://127.0.0.1:6379/9",
+            "OPTIONS": {
+                "CLIENT_CLASS": "django_redis.client.DefaultClient",
+            }
+        },
+
+3) TH_SERVICES
+
+add this line to the TH_SERVICES setting
+
+.. code-block:: python
+
+    TH_SERVICES = (
+        'th_wallabag.my_wallabag.ServiceWallabag',
+    )
+
+
+
+4) The service keys
+
+I strongly recommend that your put the following in a local_settings.py, to avoid to accidentally push this to a public repository
+
+
+.. code-block:: python
+
+    TH_WALLABAG = {
+
+        'host': 'http://localhost:8080',
+        'username': '<user>',
+        'password': '<password>',
+        'client_id': '<your client id>',
+        'client_secret': '<your client secret>'
+    }
+
+to fill the parameters, have a look at https://github.com/foxmask/wallabag_api/blob/master/README.rst
+
+creation of the table of the services
+-------------------------------------
+
+enter the following command
+
+.. code-block:: bash
+
+    python manage.py migrate
+
+
+from the admin panel, activation of the service
+-----------------------------------------------
+
+from http://yourdomain.com/admin/django_th/servicesactivated/add/
+
+* Select "Wallabag",
+* Set the Status to "Enabled"
+* Check Auth Required: this will permit to redirect to the user (or you) to your Wallabag application which will request a token
+* Fill a description
+

requirements.txt

@@ -14,3 +14,4 @@ django-haystack==2.4.1
 py-trello==0.4.3
 twython==3.3.0
 awesome-slugify==1.6.5
+wallabag_api==1.0.0

setup.py

@@ -37,10 +37,14 @@
     'awesome-slugify==1.6.5',
 ]
 
+extras_require_wallabag = [
+    'wallabag_api==1.0.0',
+]
+
 extras_require_all = extras_require_github\
     + extras_require_pocket + extras_require_readability + extras_require_rss\
     + extras_require_search + extras_require_trello + extras_require_twitter\
-    + extras_require_pelican
+    + extras_require_pelican + extras_require_wallabag
 
 setup(
     name='django_th',
@@ -77,6 +81,7 @@
         'trello': extras_require_trello,
         'twitter': extras_require_twitter,
         'pelican': extras_require_pelican,
+        'wallabag': extras_require_wallabag,
     },
     include_package_data=True,
 )