Lazar Radojevic commited on
Commit
750ea58
·
1 Parent(s): 7af929b

update README

Browse files
Files changed (1) hide show
  1. README.md +11 -39
README.md CHANGED
@@ -1,39 +1,11 @@
1
- ### Installation
2
-
3
- This project uses [poetry](https://python-poetry.org/) as dependency management tool.
4
-
5
- After setting up poetry, run the following command to install the project along with its dependencies:
6
-
7
- ```bash
8
- poetry install
9
- ```
10
-
11
- The project also uses of [poethepoet](https://poethepoet.natn.io/index.html) for defining project tasks, such as running local applications for development.
12
-
13
- These "_poe tasks_" are defined in the `pyproject.toml` file.
14
-
15
- ### Code quality and typing checks
16
-
17
- 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/).
18
-
19
- To format the code, run the following command:
20
-
21
- ```bash
22
- poetry run poe format
23
- ```
24
-
25
- To run the checks locally, run the following command:
26
-
27
- ```bash
28
- poetry run poe check
29
- ```
30
-
31
- You can also use poe task to run the tests, namely:
32
-
33
- ```bash
34
- poetry run poe test
35
- ```
36
-
37
- docker build -t prompt-search-engine .
38
-
39
- docker run -d -p 8000:8000 prompt-search-engine
 
1
+ ---
2
+ title: Prompt Engine
3
+ emoji: 💻
4
+ colorFrom: green
5
+ colorTo: green
6
+ sdk: docker
7
+ pinned: false
8
+ license: apache-2.0
9
+ ---
10
+
11
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference