Libero Search

This project is an implementation of Libero search API

Contents:

• Dependencies
• Getting Started
• Running tests locally
• Adding and removing dependencies
• Other useful commands
• Configuration
• Getting help

Dependencies

• Docker

Getting started

This project provides a Makefile with short commands to run common tasks. Typically, MacOS and most Linux distributions come with gnu make installed. If are unable to run the commands below because your system doesn't have gnu make installed, you can try to install it or copy and paste commands found in the Makefile into your command line interface.

• make help for a full list of commands.
• make start builds and/or runs the site locally configured for development purposes.
• make stop stops containers and cleans up any anonymous volumes.

Running tests locally

• make tests runs unit tests.
• make checks runs static checks such as: mypy, flake8, pylint.
• make all-tests combines the two commands above by running all checks followed by unit tests

Adding and removing dependencies

This project uses Poetry for dependency management.

To add and remove a project dependency, run make shell to enter the bash shell of the app container and make changes as necessary. Any changes made will only update pyproject.toml and poetry.lock files. If you would like to apply the changes to the app container then rebuild the container by running make build.

Example:

$ make shell
bash 4.4# poetry add pytest --dev
(ctrl + d to exit the container shell)
$ make build

Visit the official Poetry documentation for a full list of Poetry commands

Other useful commands

• make run Only runs the python service. Useful for debugging with pdb.
• make shell Enters the container and presents a bash shell.
• make dependency-tree or make d-tree Displays a dependency tree.
• make fix-imports Automatically format imports for all project python files.

Configuration

To change Flask's default settings, supply the relevant environment variables with the FLASK_ prefix. For more details see environment variables with the FLASK_ prefix

To supply search settings that need to be accessed globally, add them to search/settings.py. It is recommended that you do not commit anything to this file but instead supply your own version during deployment for portability and to safeguard sensitive information.

For development purposes, the application container expects to find docker/settings.dev.py and will replace search/settings.py in the application container.

Default Fields:

• GATEWAY_URL specify the full address of your api gateway.
• ELASTICSEARCH_HOSTS a list of urls for each elastic search node.
• CONTENT_SERVICES_TO_INDEX a list of service names to request content from.

Getting help

• Report a bug or request a feature on GitHub.
• Ask a question on the Libero Community Slack.
• Read the code of conduct.