Spaces:
Sleeping
Sleeping
### Installation | |
This project uses [poetry](https://python-poetry.org/) as dependency management tool. | |
After setting up poetry, run the following command to install the project along with its dependencies: | |
```bash | |
poetry install | |
``` | |
The project also uses of [poethepoet](https://poethepoet.natn.io/index.html) for defining project tasks, such as running local applications for development. | |
These "_poe tasks_" are defined in the `pyproject.toml` file. | |
### Code quality and typing checks | |
This project enforces code quality and typing checks using [ruff](https://docs.astral.sh/ruff/), [mypy](https://mypy.readthedocs.io/en/stable/) and [black](https://black.readthedocs.io/en/stable/). | |
To format the code, run the following command: | |
```bash | |
poetry run poe format | |
``` | |
To run the checks locally, run the following command: | |
```bash | |
poetry run poe check | |
``` | |
You can also use poe task to run the tests, namely: | |
```bash | |
poetry run poe test | |
``` | |
docker build -t prompt-search-engine . | |
docker run -d -p 8000:8000 prompt-search-engine | |