Merge pull request #920 from kvch/gh-pages

add first blog entry on python3 support
2017-05-15 14:25:01 +02:00 · 2017-05-15 14:25:01 +02:00 · 4c096f8d08
parent 12866fc179 d96ebffcef
commit 4c096f8d08
23 changed files with 334 additions and 5 deletions
--- a/_images/searxpy3.png
+++ b/_images/searxpy3.png
--- a/_sources/blog/blog.txt
+++ b/_sources/blog/blog.txt
@ -0,0 +1,7 @@
+Blog
+====
+
+.. toctree::
+   :maxdepth: 1
+
+   python3
--- a/_sources/blog/python3.txt
+++ b/_sources/blog/python3.txt
@ -0,0 +1,54 @@
+Introducing Python3 support
+===========================
+
+As most operation systems are coming with Python3 installed by default. So it is time for searx to support Python3. But don't worry support of Python2.7 won't be dropped.
+
+.. image:: searxpy3.png
+    :scale: 50 %
+    :alt: hurray
+    :align: center
+
+
+How to run searx using Python3
+------------------------------
+
+Please make sure that you run at least Python3.5.
+
+To run searx, first a Python3 virtualenv should be created. After entering the virtualenv,
+dependencies must be installed. Then run searx with python3 instead of the usual python command.
+
+.. code:: sh
+
+    virtualenv -p python3 venv3
+    source venv3/bin/activate
+    pip3 install -r requirements.txt
+    python3 searx/webapp.py
+
+
+If you want to run searx using Python2.7, you don't have to do anything differently as before.
+
+Fun facts
+---------
+
+- 115 files were changed when implementing the support for both Python versions.
+
+- All of the dependencies was compatible except for the robotframework used for browser tests. Thus, these tests were migrated to splinter. So from now on both versions are being tested on Travis and can be tested locally.
+
+If you found bugs...
+--------------------
+
+...please open an issue on `GitHub`_. Make sure that you mention your Python version in your issue,
+so we can investigate it properly.
+
+.. _GitHub: https://github.com/asciimoo/searx/issues
+
+Acknowledgement
+---------------
+
+This development was sponsored by `NLnet Foundation`_.
+
+.. _NLnet Foundation: https://nlnet.nl/
+
+
+| Happy hacking.
+| kvch // 2017.05.13 22:57
--- a/admin/api.html
+++ b/admin/api.html
@ -141,6 +141,7 @@ URL of the searx instance and values are customizable.</p>
 <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/admin/filtron.html
+++ b/admin/filtron.html
@ -153,6 +153,7 @@
 <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/blog/blog.html
+++ b/blog/blog.html
@ -0,0 +1,80 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>Blog &#8212; searx 0.11.0 documentation</title>
+    
+    <link rel="stylesheet" href="../_static/style.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '0.11.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="top" title="searx 0.11.0 documentation" href="../index.html" />
+   
+  
+  <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
+  </head>
+  <body role="document">  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="blog">
+<h1>Blog<a class="headerlink" href="#blog" title="Permalink to this headline">¶</a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="python3.html">Introducing Python3 support</a></li>
+</ul>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+<h1>Searx</h1>
+<ul>
+    <li><a href="../index.html">Home</a></li>
+    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="#">Blog</a></li>
+    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
+    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
+</ul>
+<hr />
+<ul>
+    <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
+    <li><a href="https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software">Flattr</a></li>
+    <li><a href="https://gratipay.com/searx">Gratipay</a></li>
+</ul>
+</div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy; Copyright 2015-2016, Adam Tauber.
+    </div>
+  </body>
+</html>
--- a/blog/python3.html
+++ b/blog/python3.html
@ -0,0 +1,110 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>Introducing Python3 support &#8212; searx 0.11.0 documentation</title>
+    
+    <link rel="stylesheet" href="../_static/style.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '0.11.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="top" title="searx 0.11.0 documentation" href="../index.html" />
+   
+  
+  <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
+  </head>
+  <body role="document">  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="introducing-python3-support">
+<h1>Introducing Python3 support<a class="headerlink" href="#introducing-python3-support" title="Permalink to this headline">¶</a></h1>
+<p>As most operation systems are coming with Python3 installed by default. So it is time for searx to support Python3. But don&#8217;t worry support of Python2.7 won&#8217;t be dropped.</p>
+<a class="reference internal image-reference" href="../_images/searxpy3.png"><img alt="hurray" class="align-center" src="../_images/searxpy3.png" style="width: 510.5px; height: 116.0px;" /></a>
+<div class="section" id="how-to-run-searx-using-python3">
+<h2>How to run searx using Python3<a class="headerlink" href="#how-to-run-searx-using-python3" title="Permalink to this headline">¶</a></h2>
+<p>Please make sure that you run at least Python3.5.</p>
+<p>To run searx, first a Python3 virtualenv should be created. After entering the virtualenv,
+dependencies must be installed. Then run searx with python3 instead of the usual python command.</p>
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">virtualenv</span> <span class="o">-</span><span class="n">p</span> <span class="n">python3</span> <span class="n">venv3</span>
+<span class="n">source</span> <span class="n">venv3</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
+<span class="n">pip3</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">.</span><span class="n">txt</span>
+<span class="n">python3</span> <span class="n">searx</span><span class="o">/</span><span class="n">webapp</span><span class="o">.</span><span class="n">py</span>
+</pre></div>
+</div>
+<p>If you want to run searx using Python2.7, you don&#8217;t have to do anything differently as before.</p>
+</div>
+<div class="section" id="fun-facts">
+<h2>Fun facts<a class="headerlink" href="#fun-facts" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li>115 files were changed when implementing the support for both Python versions.</li>
+<li>All of the dependencies was compatible except for the robotframework used for browser tests. Thus, these tests were migrated to splinter. So from now on both versions are being tested on Travis and can be tested locally.</li>
+</ul>
+</div>
+<div class="section" id="if-you-found-bugs">
+<h2>If you found bugs...<a class="headerlink" href="#if-you-found-bugs" title="Permalink to this headline">¶</a></h2>
+<p>...please open an issue on <a class="reference external" href="https://github.com/asciimoo/searx/issues">GitHub</a>. Make sure that you mention your Python version in your issue,
+so we can investigate it properly.</p>
+</div>
+<div class="section" id="acknowledgement">
+<h2>Acknowledgement<a class="headerlink" href="#acknowledgement" title="Permalink to this headline">¶</a></h2>
+<p>This development was sponsored by <a class="reference external" href="https://nlnet.nl/">NLnet Foundation</a>.</p>
+<div class="line-block">
+<div class="line">Happy hacking.</div>
+<div class="line">kvch // 2017.05.13 22:57</div>
+</div>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+<h1>Searx</h1>
+<ul>
+    <li><a href="../index.html">Home</a></li>
+    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="blog.html">Blog</a></li>
+    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
+    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
+</ul>
+<hr />
+<ul>
+    <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
+    <li><a href="https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software">Flattr</a></li>
+    <li><a href="https://gratipay.com/searx">Gratipay</a></li>
+</ul>
+</div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy; Copyright 2015-2016, Adam Tauber.
+    </div>
+  </body>
+</html>
--- a/dev/contribution_guide.html
+++ b/dev/contribution_guide.html
@ -133,6 +133,7 @@ files, you have to install it on your system. (It can be installed easily using
 <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/dev/engine_overview.html
+++ b/dev/engine_overview.html
@ -575,6 +575,7 @@ Currently the following media-types are supported:</p>
 <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/dev/install/installation.html
+++ b/dev/install/installation.html
@ -325,6 +325,7 @@ docker run -d --name searx -p $PORT:8888 wonderfall/searx
 <ul>
    <li><a href="../../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/dev/plugins.html
+++ b/dev/plugins.html
@ -92,6 +92,7 @@ searx.</p>
 <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/dev/quickstart.html
+++ b/dev/quickstart.html
@ -109,20 +109,22 @@ Node has to be installed.</p>
 </div>
 <div class="section" id="tips-for-debugging-development">
 <h2>Tips for debugging/development<a class="headerlink" href="#tips-for-debugging-development" title="Permalink to this headline">¶</a></h2>
-<ol class="arabic simple">
+<ol class="arabic">
 <li><dl class="first docutils">
 <dt>Turn on debug logging</dt>
-<dd>Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
+<dd><p class="first last">Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
 to turn on debug logging. When debug logging is enabled a stack trace appears,
 instead of the cryptic <code class="docutils literal"><span class="pre">Internal</span> <span class="pre">Server</span> <span class="pre">Error</span></code> message. It can be turned on by setting
-<code class="docutils literal"><span class="pre">debug:</span> <span class="pre">False</span></code> to <code class="docutils literal"><span class="pre">debug:</span> <span class="pre">True</span></code> in settings.yml.</dd>
+<code class="docutils literal"><span class="pre">debug:</span> <span class="pre">False</span></code> to <code class="docutils literal"><span class="pre">debug:</span> <span class="pre">True</span></code> in settings.yml.</p>
+</dd>
 </dl>
 </li>
 <li><dl class="first docutils">
 <dt>Run <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> before creating a PR.</dt>
-<dd>Failing build on Travis is common because of PEP8 checks. So a new commit must be created
+<dd><p class="first last">Failing build on Travis is common because of PEP8 checks. So a new commit must be created
 containing these format fixes. This phase can be skipped if <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> is run
-locally before creating a PR.</dd>
+locally before creating a PR.</p>
+</dd>
 </dl>
 </li>
 </ol>
@ -139,6 +141,7 @@ locally before creating a PR.</dd>
 <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/dev/search_api.html
+++ b/dev/search_api.html
@ -105,6 +105,7 @@
 <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/dev/translation.html
+++ b/dev/translation.html
@ -99,6 +99,7 @@ those should not be compiled. Call the command below to compile the <code class=
 <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/docs/_themes/searx_theme/relations.html
+++ b/docs/_themes/searx_theme/relations.html
@ -3,6 +3,7 @@
 <ul>
    <li><a href="{{ pathto('index') }}">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="{{ pathto('blog/blog') }}">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/docs/blog/blog.rst
+++ b/docs/blog/blog.rst
@ -0,0 +1,7 @@
+Blog
+====
+
+.. toctree::
+   :maxdepth: 1
+
+   python3
--- a/docs/blog/python3.rst
+++ b/docs/blog/python3.rst
@ -0,0 +1,54 @@
+Introducing Python3 support
+===========================
+
+As most operation systems are coming with Python3 installed by default. So it is time for searx to support Python3. But don't worry support of Python2.7 won't be dropped.
+
+.. image:: hurray.png
+    :scale: 50 %
+    :alt: hurray
+    :align: center
+
+
+How to run searx using Python3
+------------------------------
+
+Please make sure that you run at least Python3.5.
+
+To run searx, first a Python3 virtualenv should be created. After entering the virtualenv,
+dependencies must be installed. Then run searx with python3 instead of the usual python command.
+
+.. code:: sh
+
+    virtualenv -p python3 venv3
+    source venv3/bin/activate
+    pip3 install -r requirements.txt
+    python3 searx/webapp.py
+
+
+If you want to run searx using Python2.7, you don't have to do anything differently as before.
+
+Fun facts
+---------
+
+- 115 files were changed when implementing the support for both Python versions.
+
+- All of the dependencies was compatible except for the robotframework used for browser tests. Thus, these tests were migrated to splinter. So from now on both versions are being tested on Travis and can be tested locally.
+
+If you found bugs...
+--------------------
+
+...please open an issue on `GitHub`_. Make sure that you mention your Python version in your issue,
+so we can investigate it properly.
+
+.. _GitHub: https://github.com/asciimoo/searx/issues
+
+Acknowledgement
+---------------
+
+This development was sponsored by `NLnet Foundation`_.
+
+.. _NLnet Foundation: https://nlnet.nl/
+
+
+| Happy hacking.
+| kvch // 2017.05.13 22:57
--- a/docs/blog/searxpy3.png
+++ b/docs/blog/searxpy3.png
--- a/genindex.html
+++ b/genindex.html
@ -59,6 +59,7 @@
 <ul>
    <li><a href="index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/index.html
+++ b/index.html
@ -106,6 +106,7 @@
 <ul>
    <li><a href="#">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/search.html
+++ b/search.html
@ -80,6 +80,7 @@
 <ul>
    <li><a href="index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/user/own-instance.html
+++ b/user/own-instance.html
@ -87,6 +87,7 @@ This means that the user of the public instance does not know whether his/her re
 <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>
--- a/user/search_syntax.html
+++ b/user/search_syntax.html
@ -77,6 +77,7 @@ list of engines, categories and languages.</p>
 <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="../blog/blog.html">Blog</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
 </ul>