Makefile 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  1. # -*- coding: utf-8; mode: makefile-gmake -*-
  2. export GIT_URL=https://github.com/asciimoo/searx
  3. export SEARX_URL=https://searx.me
  4. export DOCS_URL=https://asciimoo.github.io/searx
  5. PYOBJECTS = searx
  6. DOC = docs
  7. PY_SETUP_EXTRAS ?= \[test\]
  8. PYDIST=./dist/py
  9. PYBUILD=./build/py
  10. include utils/makefile.include
  11. include utils/makefile.python
  12. include utils/makefile.sphinx
  13. all: clean install
  14. PHONY += help
  15. help:
  16. @echo ' test - run developer tests'
  17. @echo ' docs - build documentation'
  18. @echo ' docs-live - autobuild HTML documentation while editing'
  19. @echo ' run - run developer instance'
  20. @echo ' install - developer install (./local)'
  21. @echo ' uninstall - uninstall (./local)'
  22. @echo ' gh-pages - build docs & deploy on gh-pages branch'
  23. @echo ' clean - drop builds and environments'
  24. @echo ' project - re-build generic files of the searx project'
  25. @echo ' themes - re-build build the source of the themes'
  26. @echo ' docker - build Docker image'
  27. @echo ' node.env - download & install npm dependencies locally'
  28. @echo ''
  29. @$(MAKE) -s -f utils/makefile.include make-help
  30. @echo ''
  31. @$(MAKE) -s -f utils/makefile.python python-help
  32. PHONY += install
  33. install: pyenvinstall
  34. PHONY += uninstall
  35. uninstall: pyenvuninstall
  36. PHONY += clean
  37. clean: pyclean node.clean test.clean
  38. $(call cmd,common_clean)
  39. PHONY += run
  40. run: pyenvinstall
  41. $(Q) ( \
  42. sed -i -e "s/debug : False/debug : True/g" ./searx/settings.yml ; \
  43. sleep 2 ; \
  44. xdg-open http://127.0.0.1:8888/ ; \
  45. sleep 3 ; \
  46. sed -i -e "s/debug : True/debug : False/g" ./searx/settings.yml ; \
  47. ) &
  48. $(PY_ENV)/bin/python ./searx/webapp.py
  49. # docs
  50. # ----
  51. PHONY += docs
  52. docs: pyenvinstall sphinx-doc
  53. $(call cmd,sphinx,html,docs,docs)
  54. PHONY += docs-live
  55. docs-live: pyenvinstall sphinx-live
  56. $(call cmd,sphinx_autobuild,html,docs,docs)
  57. $(GH_PAGES)::
  58. @echo "doc available at --> $(DOCS_URL)"
  59. # update project files
  60. # --------------------
  61. PHONY += project engines.languages searx.brand useragents.update
  62. project: useragents.update engines.languages searx.brand
  63. engines.languages: pyenvinstall
  64. $(Q)echo "fetch languages .."
  65. $(Q)$(PY_ENV_ACT); python utils/fetch_languages.py
  66. $(Q)echo "update searx/data/engines_languages.json"
  67. $(Q)mv engines_languages.json searx/data/engines_languages.json
  68. $(Q)echo "update searx/languages.py"
  69. $(Q)mv languages.py searx/languages.py
  70. useragents.update: pyenvinstall
  71. $(Q)echo "Update searx/data/useragents.json with the most recent versions of Firefox."
  72. $(Q)$(PY_ENV_ACT); python utils/fetch_firefox_version.py
  73. searx.brand:
  74. $(Q)echo "build searx/brand.py"
  75. $(Q)echo "GIT_URL = '$(GIT_URL)'" > searx/brand.py
  76. $(Q)echo "ISSUE_URL = 'https://github.com/asciimoo/searx/issues'" >> searx/brand.py
  77. $(Q)echo "SEARX_URL = '$(SEARX_URL)'" >> searx/brand.py
  78. $(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py
  79. $(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py
  80. $(Q)echo "build utils/brand.env"
  81. $(Q)echo "export GIT_URL='$(GIT_URL)'" > utils/brand.env
  82. $(Q)echo "export ISSUE_URL='https://github.com/asciimoo/searx/issues'" >> utils/brand.env
  83. $(Q)echo "export SEARX_URL='$(SEARX_URL)'" >> utils/brand.env
  84. $(Q)echo "export DOCS_URL='$(DOCS_URL)'" >> utils/brand.env
  85. $(Q)echo "export PUBLIC_INSTANCES='https://searx.space'" >> utils/brand.env
  86. # node / npm
  87. # ----------
  88. node.env:
  89. $(Q)./manage.sh npm_packages
  90. node.clean:
  91. $(Q)echo "CLEAN locally installed npm dependencies"
  92. $(Q)rm -rf \
  93. ./node_modules \
  94. ./package-lock.json \
  95. ./searx/static/themes/oscar/package-lock.json \
  96. ./searx/static/themes/oscar/node_modules \
  97. ./searx/static/themes/simple/package-lock.json \
  98. ./searx/static/themes/simple/node_modules
  99. # build themes
  100. # ------------
  101. PHONY += themes.bootstrap themes themes.oscar themes.simple themes.legacy themes.courgette themes.pixart
  102. themes: themes.bootstrap themes.oscar themes.simple themes.legacy themes.courgette themes.pixart
  103. quiet_cmd_lessc = LESSC $3
  104. cmd_lessc = PATH="$$(npm bin):$$PATH" \
  105. lessc --clean-css="--s1 --advanced --compatibility=ie9" "searx/static/$2" "searx/static/$3"
  106. quiet_cmd_grunt = GRUNT $2
  107. cmd_grunt = PATH="$$(npm bin):$$PATH" \
  108. grunt --gruntfile "$2"
  109. themes.oscar:
  110. $(Q)echo '[!] build oscar theme'
  111. $(call cmd,grunt,searx/static/themes/oscar/gruntfile.js)
  112. themes.simple:
  113. $(Q)echo '[!] build simple theme'
  114. $(call cmd,grunt,searx/static/themes/simple/gruntfile.js)
  115. themes.legacy:
  116. $(Q)echo '[!] build legacy theme'
  117. $(call cmd,lessc,themes/legacy/less/style-rtl.less,themes/legacy/css/style-rtl.css)
  118. $(call cmd,lessc,themes/legacy/less/style.less,themes/legacy/css/style.css)
  119. themes.courgette:
  120. $(Q)echo '[!] build courgette theme'
  121. $(call cmd,lessc,themes/courgette/less/style.less,themes/courgette/css/style.css)
  122. $(call cmd,lessc,themes/courgette/less/style-rtl.less,themes/courgette/css/style-rtl.css)
  123. themes.pixart:
  124. $(Q)echo '[!] build pixart theme'
  125. $(call cmd,lessc,themes/pix-art/less/style.less,themes/pix-art/css/style.css)
  126. themes.bootstrap:
  127. $(call cmd,lessc,less/bootstrap/bootstrap.less,css/bootstrap.min.css)
  128. # docker
  129. # ------
  130. PHONY += docker
  131. docker:
  132. $(Q)./manage.sh docker_build
  133. # gecko
  134. # -----
  135. PHONY += gecko.driver
  136. gecko.driver:
  137. $(PY_ENV_ACT); ./manage.sh install_geckodriver
  138. # test
  139. # ----
  140. PHONY += test test.pylint test.pep8 test.unit test.coverage test.robot
  141. test: test.pylint test.pep8 test.unit gecko.driver test.robot
  142. # TODO: balance linting with pylint
  143. test.pylint: pyenvinstall
  144. $(call cmd,pylint,\
  145. searx/preferences.py \
  146. searx/testing.py \
  147. )
  148. # ignored rules:
  149. # E402 module level import not at top of file
  150. # W503 line break before binary operator
  151. test.pep8: pyenvinstall
  152. @echo "TEST pep8"
  153. $(Q)$(PY_ENV_ACT); pep8 --exclude=searx/static --max-line-length=120 --ignore "E402,W503" searx tests
  154. test.unit: pyenvinstall
  155. @echo "TEST tests/unit"
  156. $(Q)$(PY_ENV_ACT); python -m nose2 -s tests/unit
  157. test.coverage: pyenvinstall
  158. @echo "TEST unit test coverage"
  159. $(Q)$(PY_ENV_ACT); \
  160. python -m nose2 -C --log-capture --with-coverage --coverage searx -s tests/unit \
  161. && coverage report \
  162. && coverage html \
  163. test.robot: pyenvinstall gecko.driver
  164. @echo "TEST robot"
  165. $(Q)$(PY_ENV_ACT); PYTHONPATH=. python searx/testing.py robot
  166. test.clean:
  167. @echo "CLEAN intermediate test stuff"
  168. $(Q)rm -rf geckodriver.log .coverage coverage/
  169. .PHONY: $(PHONY)