Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add Meilisearch-compatible search engine #162

Closed
wants to merge 4 commits into from
Closed

feat: add Meilisearch-compatible search engine #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff17750
fix: `make test` command
regisb Oct 17, 2024
151f865
feat: add convenient "make compile-requirements" command
regisb Oct 17, 2024
44d2424
feat: add Meilisearch-compatible search engine
regisb Oct 17, 2024
fa0fc71
chore: bump version to 4.0.1
regisb Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,23 +34,26 @@ test_with_es: clean test.start_elasticsearch
coverage run --source='.' manage.py test
make test.stop_elasticsearch

upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
upgrade: ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
compile-requirements: export CUSTOM_COMPILE_COMMAND=make upgrade
compile-requirements: ## Re-compile *.in requirements to *.txt (without upgrading)
pip install -qr requirements/pip-tools.txt
# Make sure to compile files after any other files they include!
pip-compile --rebuild --allow-unsafe --rebuild -o requirements/pip.txt requirements/pip.in
pip-compile --rebuild --upgrade -o requirements/pip-tools.txt requirements/pip-tools.in
pip-compile --rebuild ${COMPILE_OPTS} -o requirements/pip-tools.txt requirements/pip-tools.in
pip install -qr requirements/pip.txt
pip install -qr requirements/pip-tools.txt
pip-compile --rebuild --upgrade -o requirements/base.txt requirements/base.in
pip-compile --rebuild --upgrade -o requirements/testing.txt requirements/testing.in
pip-compile --rebuild --upgrade -o requirements/quality.txt requirements/quality.in
pip-compile --rebuild --upgrade -o requirements/ci.txt requirements/ci.in
pip-compile --rebuild --upgrade -o requirements/dev.txt requirements/dev.in
pip-compile --rebuild ${COMPILE_OPTS} -o requirements/base.txt requirements/base.in
pip-compile --rebuild ${COMPILE_OPTS} -o requirements/testing.txt requirements/testing.in
pip-compile --rebuild ${COMPILE_OPTS} -o requirements/quality.txt requirements/quality.in
pip-compile --rebuild ${COMPILE_OPTS} -o requirements/ci.txt requirements/ci.in
pip-compile --rebuild ${COMPILE_OPTS} -o requirements/dev.txt requirements/dev.in
# Let tox control the Django version for tests
sed '/^[dD]jango==/d' requirements/testing.txt > requirements/testing.tmp
mv requirements/testing.tmp requirements/testing.txt

upgrade: ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
$(MAKE) compile-requirements COMPILE_OPTS="--upgrade"

test: test_with_es ## run tests and generate coverage report

install-local: ## installs your local edx-search into the LMS and CMS python virtualenvs
Expand Down
2 changes: 1 addition & 1 deletion edxsearch/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
""" Container module for testing / demoing search """

__version__ = '4.0.0'
__version__ = '4.0.1'
2 changes: 1 addition & 1 deletion manage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import sys

if __name__ == "__main__":
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "edxsearch.settings")
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[question]: Why was this done? Why do we have these separate settings modules at all?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was to fix an existing issue with that manage.py file -- it was referencing a non-existent file. AFAIK, you'd only use this to run a dev server locally, not for anything real.


from django.core.management import execute_from_command_line

Expand Down
1 change: 1 addition & 0 deletions requirements/base.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ Django # Web application framework
elasticsearch>=7.8.0,<8.0.0
edx-toggles
event-tracking
meilisearch
29 changes: 26 additions & 3 deletions requirements/base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,26 @@
#
amqp==5.2.0
# via kombu
annotated-types==0.7.0
# via pydantic
asgiref==3.8.1
# via django
attrs==23.2.0
# via openedx-events
billiard==4.2.0
# via celery
camel-converter[pydantic]==4.0.1
# via meilisearch
celery==5.4.0
# via event-tracking
certifi==2024.7.4
# via elasticsearch
# via
# elasticsearch
# requests
cffi==1.16.0
# via pynacl
charset-normalizer==3.4.0
# via requests
click==8.1.7
# via
# celery
Expand Down Expand Up @@ -77,12 +85,16 @@ event-tracking==2.4.0
# -r requirements/base.in
fastavro==1.9.5
# via openedx-events
idna==3.10
# via requests
jinja2==3.1.4
# via code-annotations
kombu==5.3.7
# via celery
markupsafe==2.1.5
# via jinja2
meilisearch==0.31.5
# via -r requirements/base.in
newrelic==9.12.0
# via edx-django-utils
openedx-events==9.11.0
Expand All @@ -95,6 +107,10 @@ psutil==6.0.0
# via edx-django-utils
pycparser==2.22
# via cffi
pydantic==2.9.2
# via camel-converter
pydantic-core==2.23.4
# via pydantic
pymongo==3.13.0
# via
# edx-opaque-keys
Expand All @@ -109,6 +125,8 @@ pytz==2024.1
# via event-tracking
pyyaml==6.0.1
# via code-annotations
requests==2.32.3
# via meilisearch
six==1.16.0
# via
# edx-ccx-keys
Expand All @@ -124,11 +142,16 @@ stevedore==5.2.0
text-unidecode==1.3
# via python-slugify
typing-extensions==4.12.2
# via edx-opaque-keys
# via
# edx-opaque-keys
# pydantic
# pydantic-core
tzdata==2024.1
# via celery
urllib3==1.26.19
# via elasticsearch
# via
# elasticsearch
# requests
vine==5.1.0
# via
# amqp
Expand Down
43 changes: 43 additions & 0 deletions requirements/dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ amqp==5.2.0
# -r requirements/quality.txt
# -r requirements/testing.txt
# kombu
annotated-types==0.7.0
# via
# -r requirements/quality.txt
# -r requirements/testing.txt
# pydantic
asgiref==3.8.1
# via
# -r requirements/quality.txt
Expand Down Expand Up @@ -37,6 +42,11 @@ cachetools==5.4.0
# via
# -r requirements/ci.txt
# tox
camel-converter[pydantic]==4.0.1
# via
# -r requirements/quality.txt
# -r requirements/testing.txt
# meilisearch
celery==5.4.0
# via
# -r requirements/quality.txt
Expand All @@ -47,6 +57,7 @@ certifi==2024.7.4
# -r requirements/quality.txt
# -r requirements/testing.txt
# elasticsearch
# requests
cffi==1.16.0
# via
# -r requirements/quality.txt
Expand All @@ -56,6 +67,11 @@ chardet==5.2.0
# via
# -r requirements/ci.txt
# tox
charset-normalizer==3.4.0
# via
# -r requirements/quality.txt
# -r requirements/testing.txt
# requests
click==8.1.7
# via
# -r requirements/pip-tools.txt
Expand Down Expand Up @@ -185,6 +201,11 @@ filelock==3.15.4
# -r requirements/ci.txt
# tox
# virtualenv
idna==3.10
# via
# -r requirements/quality.txt
# -r requirements/testing.txt
# requests
iniconfig==2.0.0
# via
# -r requirements/quality.txt
Expand Down Expand Up @@ -213,6 +234,10 @@ mccabe==0.7.0
# via
# -r requirements/quality.txt
# pylint
meilisearch==0.31.5
# via
# -r requirements/quality.txt
# -r requirements/testing.txt
mock==5.1.0
# via
# -r requirements/quality.txt
Expand Down Expand Up @@ -275,6 +300,16 @@ pycparser==2.22
# -r requirements/quality.txt
# -r requirements/testing.txt
# cffi
pydantic==2.9.2
# via
# -r requirements/quality.txt
# -r requirements/testing.txt
# camel-converter
pydantic-core==2.23.4
# via
# -r requirements/quality.txt
# -r requirements/testing.txt
# pydantic
pylint==3.2.6
# via
# -r requirements/quality.txt
Expand Down Expand Up @@ -344,6 +379,11 @@ pyyaml==6.0.1
# -r requirements/quality.txt
# -r requirements/testing.txt
# code-annotations
requests==2.32.3
# via
# -r requirements/quality.txt
# -r requirements/testing.txt
# meilisearch
six==1.16.0
# via
# -r requirements/quality.txt
Expand Down Expand Up @@ -380,6 +420,8 @@ typing-extensions==4.12.2
# -r requirements/quality.txt
# -r requirements/testing.txt
# edx-opaque-keys
# pydantic
# pydantic-core
tzdata==2024.1
# via
# -r requirements/quality.txt
Expand All @@ -390,6 +432,7 @@ urllib3==1.26.19
# -r requirements/quality.txt
# -r requirements/testing.txt
# elasticsearch
# requests
vine==5.1.0
# via
# -r requirements/quality.txt
Expand Down
34 changes: 34 additions & 0 deletions requirements/quality.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ amqp==5.2.0
# via
# -r requirements/testing.txt
# kombu
annotated-types==0.7.0
# via
# -r requirements/testing.txt
# pydantic
asgiref==3.8.1
# via
# -r requirements/testing.txt
Expand All @@ -24,6 +28,10 @@ billiard==4.2.0
# via
# -r requirements/testing.txt
# celery
camel-converter[pydantic]==4.0.1
# via
# -r requirements/testing.txt
# meilisearch
celery==5.4.0
# via
# -r requirements/testing.txt
Expand All @@ -32,10 +40,15 @@ certifi==2024.7.4
# via
# -r requirements/testing.txt
# elasticsearch
# requests
cffi==1.16.0
# via
# -r requirements/testing.txt
# pynacl
charset-normalizer==3.4.0
# via
# -r requirements/testing.txt
# requests
click==8.1.7
# via
# -r requirements/testing.txt
Expand Down Expand Up @@ -130,6 +143,10 @@ fastavro==1.9.5
# via
# -r requirements/testing.txt
# openedx-events
idna==3.10
# via
# -r requirements/testing.txt
# requests
iniconfig==2.0.0
# via
# -r requirements/testing.txt
Expand All @@ -150,6 +167,8 @@ markupsafe==2.1.5
# jinja2
mccabe==0.7.0
# via pylint
meilisearch==0.31.5
# via -r requirements/testing.txt
mock==5.1.0
# via -r requirements/testing.txt
newrelic==9.12.0
Expand Down Expand Up @@ -188,6 +207,14 @@ pycparser==2.22
# via
# -r requirements/testing.txt
# cffi
pydantic==2.9.2
# via
# -r requirements/testing.txt
# camel-converter
pydantic-core==2.23.4
# via
# -r requirements/testing.txt
# pydantic
pylint==3.2.6
# via
# edx-lint
Expand Down Expand Up @@ -233,6 +260,10 @@ pyyaml==6.0.1
# via
# -r requirements/testing.txt
# code-annotations
requests==2.32.3
# via
# -r requirements/testing.txt
# meilisearch
six==1.16.0
# via
# -r requirements/testing.txt
Expand Down Expand Up @@ -260,6 +291,8 @@ typing-extensions==4.12.2
# via
# -r requirements/testing.txt
# edx-opaque-keys
# pydantic
# pydantic-core
tzdata==2024.1
# via
# -r requirements/testing.txt
Expand All @@ -268,6 +301,7 @@ urllib3==1.26.19
# via
# -r requirements/testing.txt
# elasticsearch
# requests
vine==5.1.0
# via
# -r requirements/testing.txt
Expand Down
Loading
Loading