mirror of
https://github.com/searxng/searxng.git
synced 2024-11-26 04:41:00 +00:00
3486613a19
A *brand* of searx is a fork which might have its own design and some special functions which might bee reasonable in a special context. In this sense, the fork might have its own documentation but not its own issue tracker. The *upstream* of a brand is always https://github.com/asciimoo from where the brand-fork pulls the master branch regularly. A fork which has its own issue tracker is a spin-off and out of the scope of the searx project itself. The conclusion is: - hard code ISSUE_URL (in the Makefile) - always refer to DOCS_URL - links in the about page refer to the *upstream* (searx project) except DOCS_URL - "fork me on github" ribbons refer to the *upstream* Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
154 lines
3.9 KiB
Makefile
154 lines
3.9 KiB
Makefile
# -*- coding: utf-8; mode: makefile-gmake -*-
|
|
|
|
export GIT_URL=https://github.com/asciimoo/searx
|
|
export SEARX_URL=https://searx.me
|
|
export DOCS_URL=https://asciimoo.github.io/searx
|
|
|
|
PYOBJECTS = searx
|
|
DOC = docs
|
|
PY_SETUP_EXTRAS ?= \[test\]
|
|
|
|
PYDIST=./dist/py
|
|
PYBUILD=./build/py
|
|
|
|
include utils/makefile.include
|
|
include utils/makefile.python
|
|
include utils/makefile.sphinx
|
|
|
|
all: clean install
|
|
|
|
PHONY += help
|
|
help:
|
|
@echo ' test - run developer tests'
|
|
@echo ' docs - build documentation'
|
|
@echo ' docs-live - autobuild HTML documentation while editing'
|
|
@echo ' run - run developer instance'
|
|
@echo ' install - developer install (./local)'
|
|
@echo ' uninstall - uninstall (./local)'
|
|
@echo ' gh-pages - build docs & deploy on gh-pages branch'
|
|
@echo ' clean - drop builds and environments'
|
|
@echo ' project - re-build generic files of the searx project'
|
|
@echo ' themes - re-build build the source of the themes'
|
|
@echo ' docker - build Docker image'
|
|
@echo ' node.env - download & install npm dependencies locally'
|
|
@echo ''
|
|
@$(MAKE) -s -f utils/makefile.include make-help
|
|
@echo ''
|
|
@$(MAKE) -s -f utils/makefile.python python-help
|
|
|
|
PHONY += install
|
|
install: pyenvinstall
|
|
|
|
PHONY += uninstall
|
|
uninstall: pyenvuninstall
|
|
|
|
PHONY += clean
|
|
clean: pyclean node.clean
|
|
$(call cmd,common_clean)
|
|
|
|
PHONY += run
|
|
run: pyenvinstall
|
|
$(Q) ( \
|
|
sed -i -e "s/debug : False/debug : True/g" ./searx/settings.yml ; \
|
|
sleep 2 ; \
|
|
xdg-open http://127.0.0.1:8888/ ; \
|
|
sleep 3 ; \
|
|
sed -i -e "s/debug : True/debug : False/g" ./searx/settings.yml ; \
|
|
) &
|
|
$(PY_ENV)/bin/python ./searx/webapp.py
|
|
|
|
# docs
|
|
# ----
|
|
|
|
PHONY += docs
|
|
docs: pyenvinstall sphinx-doc
|
|
$(call cmd,sphinx,html,docs,docs)
|
|
|
|
PHONY += docs-live
|
|
docs-live: pyenvinstall sphinx-live
|
|
$(call cmd,sphinx_autobuild,html,docs,docs)
|
|
|
|
$(GH_PAGES)::
|
|
@echo "doc available at --> $(DOCS_URL)"
|
|
|
|
# update project files
|
|
# --------------------
|
|
|
|
PHONY += project engines-languages searx.brand
|
|
|
|
project: searx/data/engines_languages.json searx.brand
|
|
|
|
engines-languages: pyenvinstall
|
|
$(PY_ENV_ACT); python utils/fetch_languages.py
|
|
mv engines_languages.json searx/data/engines_languages.json
|
|
mv languages.py searx/languages.py
|
|
|
|
searx.brand:
|
|
$(Q)echo "build searx/brand.py"
|
|
$(Q)echo "GIT_URL = '$(GIT_URL)'" > searx/brand.py
|
|
$(Q)echo "ISSUE_URL = 'https://github.com/asciimoo/searx/issues'" >> searx/brand.py
|
|
$(Q)echo "SEARX_URL = '$(SEARX_URL)'" >> searx/brand.py
|
|
$(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py
|
|
$(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py
|
|
|
|
# node / npm
|
|
# ----------
|
|
|
|
node.env:
|
|
$(Q)./manage.sh npm_packages
|
|
|
|
node.clean:
|
|
$(Q)echo "CLEAN locally installed npm dependencies"
|
|
$(Q)rm -rf \
|
|
./node_modules \
|
|
./package-lock.json \
|
|
./searx/static/themes/oscar/package-lock.json \
|
|
./searx/static/themes/oscar/node_modules \
|
|
./searx/static/themes/simple/package-lock.json \
|
|
./searx/static/themes/simple/node_modules
|
|
|
|
# build themes
|
|
# ------------
|
|
|
|
PHONY += themes themes.oscar themes.simple
|
|
themes: themes.oscar themes.simple
|
|
|
|
themes.oscar:
|
|
$(Q)echo '[!] Grunt build : oscar theme'
|
|
$(Q)PATH="$$(npm bin):$$PATH" grunt --gruntfile "searx/static/themes/oscar/gruntfile.js"
|
|
|
|
themes.simple:
|
|
$(Q)echo '[!] Grunt build : simple theme'
|
|
$(Q)PATH="$$(npm bin):$$PATH" grunt --gruntfile "searx/static/themes/simple/gruntfile.js"
|
|
|
|
# docker
|
|
# ------
|
|
|
|
PHONY += docker
|
|
docker:
|
|
$(Q)./manage.sh docker_build
|
|
|
|
|
|
# test
|
|
# ----
|
|
|
|
PHONY += test test.pylint test.pep8 test.unit test.robot
|
|
|
|
test: test.pylint test.pep8 test.unit test.robot
|
|
|
|
# TODO: balance linting with pylint
|
|
test.pylint: pyenvinstall
|
|
$(call cmd,pylint,searx/preferences.py)
|
|
$(call cmd,pylint,searx/testing.py)
|
|
|
|
test.pep8: pyenvinstall
|
|
$(PY_ENV_ACT); ./manage.sh pep8_check
|
|
|
|
test.unit: pyenvinstall
|
|
$(PY_ENV_ACT); ./manage.sh unit_tests
|
|
|
|
test.robot: pyenvinstall
|
|
$(PY_ENV_ACT); ./manage.sh install_geckodriver
|
|
$(PY_ENV_ACT); ./manage.sh robot_tests
|
|
|
|
.PHONY: $(PHONY)
|