Commit Graph

44 Commits (master)

Author SHA1 Message Date
Markus Heiser b1912607ae [mod] replace /help by /info pages and include pages in project docs
This patch implements a bolierplate to share content from info-pages of the
SearXNG instance (URL /info) with the project documentation (path /docs/user).

The info pages are using Markdown (CommonMark), to include them in the project
documentation (reST) the myst-parser [1] is used in the Sphinx-doc build chain.

If base_url is known (defined in settings.yml) links to the instance are also
inserted into the project documentation::

    searxng_extra/docs_prebuild

[1] https://www.sphinx-doc.org/en/master/usage/markdown.html

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2 years ago
Gaspard d'Hautefeuille 1df70b6aee
Fix setup.py help folder 2 years ago
Alexandre Flament 76cbfbbdda reference docs.searxng.org 2 years ago
Alexandre Flament 34b820a87d [fix] PR #646 2 years ago
Alexandre Flament 1bb82a6b54 SearXNG: searxng_extra 3 years ago
Alexandre Flament 499c7b3cce SearXNG: .github, searxng-docker 3 years ago
Alexandre Flament 4b43775c91 version based on the git repository
This commit remove the need to update the brand for GIT_URL and GIT_BRANCH:
there are read from the git repository.

It is possible to call python -m searx.version freeze to freeze the current version.
Useful when the code is installed outside git (distro package, docker, etc...)
3 years ago
Markus Heiser 3e50e8de3e [mod] drop usage of the searx.brand namespace (python procs)
Added function searx.get_setting(name, default=_unset):
  Returns the value to which ``name`` point.  If there is no such name in the
  settings and the ``default`` is unset, a KeyError exception is raised.

In all the python processes ..

- make docs
- make buildenv
- make install (setup.py)

the usage of the 'brand.*' name space is replaced by 'searx.get_setting'
function.

- brand.SEARX_URL        --> get_setting('server.base_url')
- brand.GIT_URL          --> get_setting('brand.git_url')
- brand.GIT_BRANCH'      --> get_setting('server.base_url')
- brand.ISSUE_URL        --> get_setting('brand.issue_url')
- brand.DOCS_URL         --> get_setting('brand.docs_url')
- brand.PUBLIC_INSTANCES --> get_setting('brand.public_instances')
- brand.CONTACT_URL      --> get_setting('general.contact_url', '')
- brand.WIKI_URL         --> get_setting('brand.wiki_url')
- brand.TWITTER_URL      --> get_setting('brand.twitter_url', '')

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
Alexandre Flament b8cd326464 Add searx_extra package
Split the utils directory into:
* searx_extra contains update scripts, standalone_searx.py
* utils contains the files to build and setup searx.
3 years ago
Alexandre Flament 3a9f513521 [enh] checker: background check
See settings.yml for the options
SIGUSR1 signal starts the checker.
The result is available at /stats/checker
3 years ago
Markus Heiser 9e53470b4c [mod] get rid of searx/brand.py
Removes module searx/brand.py and creates a namespace at searx.brand.

This patch is a first 'proof of concept'.  Later we can decide to remove the
brand namespace entirely or not.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
Markus Heiser 3c45fb7a99
[fix] set encoding of README.rst explicit in setup.py (utf-8) (#2117)
## What does this PR do?

When installing searx on a centos-7 image [1] an encoding exception is raised from setup.py::

    command: /usr/local/searx/searx-pyenv/bin/python3 -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/usr/local/searx/searx-src/setup.py'"'"'; __file__='"'"'/usr/local/searx/searx-src/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'rn'"'"', '"'"'n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base /tmp/pip-pip-egg-info-pidntzkq
         cwd: /usr/local/searx/searx-src/
    Complete output (7 lines):
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "/usr/local/searx/searx-src/setup.py", line 16, in <module>
        long_description = f.read()
      File "/usr/lib64/python3.6/encodings/ascii.py", line 26, in decode
        return codecs.ascii_decode(input, self.errors)[0]
    UnicodeDecodeError: 'ascii' codec can't decode byte 0xc9 in position 482: ordinal not in range(128)

[1] https://uk.images.linuxcontainers.org/

## Why is this change important?

README.rst uses non ASCII characters _(pronunciation səːks.)_

## How to test this PR locally?

install searx on a centos-7 image from https://uk.images.linuxcontainers.org/
4 years ago
Markus Heiser 3381471933 brands: add ISSUE_URL
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
Markus Heiser f6b29f68a1 [fix] brands: add variables from build env to setup.py
We have some variables in the build environment which are also needed in the
setup.py process.  Theses variables are relavant if one creates a fork with
its own branding.  We treat these variables under the term 'brands'.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
Markus Heiser a56c56ead3 seatup.py: fix [dev_]requirements and open file with context
setup(..) named arguments 'install_requires' and 'extras_require' need lists
arguments, the <map object> is ignored when installing extra environment
'test'::

  pip install -e .\[test\]

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
Robin Hallabro 4977ea5405
setup: Skip test files
Signed-off-by: Robin Hallabro <robin@hallabro.nu>
6 years ago
Adam Tauber ca45c24162 [fix] missing requirements files from setup.py - closes #572 8 years ago
Adam Tauber 5c073fdd83 [enh] setup.py requirements ++ new folders 8 years ago
Adam Tauber 37eb0fb130 [fix] data directory added to setup.py package_data 9 years ago
Adam Tauber 333b6759ac [fix] setup.py package data update - fixes #323 9 years ago
Alexandre Flament 201928d2b0 [fix] SSL : SNI support 9 years ago
Cqoicebordel 4ea03de11d Copy all the folders of 'static'
Copy the new generic themes folders, with js, font, and css
9 years ago
Thomas Pointhuber 7adb17452d [enh] add result_templates/code.html 9 years ago
Adam Tauber d959cb1c05 [enh] gevent/grequests changed to the built-in threading lib 10 years ago
Reventl0v 262e12202a Adding `import sys` to fix the installer 10 years ago
Thomas Pointhuber aba65369d2 [enh] make version of searx readable 10 years ago
Matej Cotman c511b6fda8 change package data in setup.py for oscar theme 10 years ago
Adam Tauber 7be9759703 [enh][fix] https rewrite rules added to setup.py 10 years ago
Adam Tauber f72255e342 [enh] setup.py keywords 10 years ago
Adam Tauber ce719ac50c [enh] setup.py classifiers 10 years ago
Adam Tauber 137df2efef [deploy] new pypi package (0.3.1) 10 years ago
Matej Cotman 3ea2b1ee86 change package data paths 10 years ago
Thomas Pointhuber 337bd6d907 simplify datetime extraction 10 years ago
Adam Tauber 62ab6579b3 [enh] 0.3.0 pypi version 10 years ago
Matej Cotman 2f7080383b add xml templates to setup.py 10 years ago
asciimoo 178d671931 [fix] translations path 10 years ago
Matej Cotman 2bcc949abe add view tests 10 years ago
asciimoo 1dfb7b9fe6 [enh] new version - 0.2.0 10 years ago
asciimoo 852dfc77c6 [enh] configurable localization 10 years ago
asciimoo 598535b24a [mod] ui localization init - new dependency: flask-babel 10 years ago
asciimoo 28b72d87e2 [mod] setup.py version, README update 10 years ago
Matej Cotman dd4662978d fix: robot fw, entry points, some flake8, package searx egg 10 years ago
asciimoo 3afdd1d994 [enh] settings unification - new dependency: pyyaml 10 years ago
Matej Cotman e740c8a8ea tests and robot tests framework, build overhaul 10 years ago