Skip to content

Commit

Permalink
build: 🎨 improve Python virtual environment setup
Browse files Browse the repository at this point in the history
  • Loading branch information
davidgasquez committed May 8, 2024
1 parent 79abd04 commit 031c29e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,13 @@ If you hit any issue, please [open an issue](https:github.com/datonic/datadex/is

### 🐍 Python Virtual Environment

You can install all the dependencies inside a Python virtual environment. To do that, clone the repository and run the following commands from the root folder:
You can install all the dependencies inside a Python virtual environment by running `make dev`. To do that, clone the repository and run the following commands from the root folder.

```bash
make dev
```

Alternatively, you can rely on your system's Python installation to create a virtual environment and install the dependencies.

```bash
# Create a virtual environment
Expand All @@ -55,8 +61,6 @@ source .venv/bin/activate
pip install -e .[dev]
```

Alternatively, you can use `make setup` which will install and setup the project for you using `uv`.

Now, you should be able to spin up Dagster UI (`make dev` or `dagster dev`) and [access it locally](http://127.0.0.1:3000).

### 🐳 Docker / Dev Containers
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Issues = "https://github.com/davidgasquez/datadex/issues"
CI = "https://github.com/davidgasquez/datadex/actions"

[project.optional-dependencies]
dev = ["dagit", "ruff"]
dev = ["dagster-webserver==1.7.4", "ruff"]

[build-system]
requires = ["setuptools"]
Expand Down

0 comments on commit 031c29e

Please sign in to comment.