Introduction

Installation

Installing Poetry

This tool uses poetry. If you already have poetry installed, please skip to the next section. Otherwise, let’s first setup poetry.

To install poetry, simply run this command:

curl -sSL https://install.python-poetry.org | python3 -

You can find out more about poetry installation here.

That’s it, poetry is set up.

Installing the package

Thanks to poetry, installing this package is very simple and can be done in a single command. Simply run:

poetry install

That’s it, the package is installed. Move to the next section to learn how to use this package.

Getting Started

< Add instructions on how to use project here >

Building the documentation

To build the documentation you can simply use the docker image. To do so, simply run:

docker build . -f Dockerfile --target documentation -t github_search_engine-docs