Browse Source

[mod] tineye - add some documentation

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Markus Heiser 3 years ago
parent
commit
b7f74fbe42
2 changed files with 22 additions and 1 deletions
  1. 9 0
      docs/src/searx.engines.tineye.rst
  2. 13 1
      searx/engines/tineye.py

+ 9 - 0
docs/src/searx.engines.tineye.rst

@@ -0,0 +1,9 @@
+.. _tineye engine:
+
+======
+Tineye
+======
+
+.. automodule:: searx.engines.tineye
+  :members:
+

+ 13 - 1
searx/engines/tineye.py

@@ -1,6 +1,17 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-"""Tineye - Reverse search images
+"""This engine implements *Tineye - reverse image search*
+
+Using TinEye, you can search by image or perform what we call a reverse image
+search.  You can do that by uploading an image or searching by URL. You can also
+simply drag and drop your images to start your search.  TinEye constantly crawls
+the web and adds images to its index.  Today, the TinEye index is over 50.2
+billion images `[tineye.com] <https://tineye.com/how>`_.
+
+.. hint::
+
+   This SearXNG engine only supports *'searching by URL'* and it does not use
+   the official API `[api.tineye.com] <https://api.tineye.com/python/docs/>`_.
 
 """
 
@@ -11,6 +22,7 @@ from datetime import datetime
 about = {
     "website": 'https://tineye.com',
     "wikidata_id": 'Q2382535',
+    "official_api_documentation": 'https://api.tineye.com/python/docs/',
     "use_official_api": False,
     "require_api_key": False,
     "results": 'JSON',