Skip to content

Commit

Permalink
docs: update readmes after adding uv as package manager
Browse files Browse the repository at this point in the history
  • Loading branch information
EgonFerri committed Oct 25, 2024
1 parent 8bcf0b2 commit f276cbb
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 13 deletions.
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,41 +57,56 @@ git clone https://github.com/immobiliare/ufoid
cd ufoid
```

Here’s a minimal installation guide based on your specified style:

## Installation

### Clone Project Repository

```shell
git clone https://github.com/your-username/your-project
cd your-project
```

### Create virtualenv and install requirements

In order to create a clean environment for the execution of the application, a new virtualenv should be created
inside the current folder, using the command
In order to create a clean environment for the execution of the application, a new virtualenv should be created inside the current folder.

#### If using `uv`

```console
uv venv
```

In order to activate the virtualenv, execute
#### If using plain Python

```console
source .venv/bin/activate
python -m venv venv
source venv/bin/activate
```

and install python requirements executing
### Install project dependencies

Once the virtual environment is activated, install the project dependencies specified in the `.toml` file:

```console
uv sync
pip install .
```

if you are interested in running the tests
Your environment is now ready to run the project.

### Run tests

```console
uvx pytest
uv run pytest
```

if you need to run benchmarks
or

```console
uv add imagededup wget
python -m pytest
```

Then you should run

## Configuration

Clone `ufoid/config/config.yaml.example` and rename it as `config.yaml` allows you to customize various aspects of the
Expand Down
15 changes: 14 additions & 1 deletion benchmarks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,20 @@ The results are saved to a CSV file for analysis.

### How to Use the Script

#### 1. Write the Configuration File
#### 1. Install dependencies

```console
uv add imagededup==0.3.2 wget==3.2.0
```

or

```console
pip install imagededup==0.3.2 wget==3.2.0
```


#### 2. Write the Configuration File

The configuration file (`optimization.yaml`) is written in YAML format and defines the parameters for the benchmarking
tests. You find an example in `benchmarks/scripts/config/optimization.yaml.example`.
Expand Down

0 comments on commit f276cbb

Please sign in to comment.