You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: enhance development setup with Makefile commands
- Added `pyright` command to Makefile for type checking.
- Updated `pyright` script in package.json to use the correct Python path.
- Revised README to reflect the new Make commands for initializing and upgrading dependencies.
- Simplified instructions for running tests and the sample dagster project using Make commands.
Copy file name to clipboardExpand all lines: README.md
+23-7Lines changed: 23 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -55,21 +55,33 @@ _Note: this is a python project but some of our dependent tools are in typescrip
55
55
56
56
### Installing
57
57
58
-
To install everything you need for development just do the following:
58
+
The project uses Make commands to simplify the development setup process. To get started:
59
59
60
60
```bash
61
-
poetry install
62
-
pnpm install
61
+
make init
62
+
```
63
+
64
+
This will:
65
+
- Set up a Python virtual environment with Python 3.12
66
+
- Install all Python dependencies
67
+
- Install Node.js dependencies via pnpm
68
+
69
+
_Note: All Make commands automatically use the correct virtual environment - you don't need to activate it manually._
70
+
71
+
To upgrade dependencies:
72
+
```bash
73
+
make upgrade-python-deps # Upgrade Python dependencies
74
+
make upgrade-node-deps # Upgrade Node.js dependencies
63
75
```
64
76
65
77
### Running tests
66
78
67
79
We have tests that should work entirely locally. You may see a `db.db` file appear in the root of the repository when these tests are run. It can be safely ignored or deleted.
68
80
69
-
We run tests with `pytest` like so:
81
+
To run tests:
70
82
71
83
```bash
72
-
poetry run pytest
84
+
make test
73
85
```
74
86
75
87
### Running the "sample" dagster project
@@ -79,13 +91,17 @@ accompanying sqlmesh project from `sample/sqlmesh_project` configured as an
79
91
asset. To run the sample dagster project deployment with a UI:
80
92
81
93
```bash
82
-
poetry run dagster dev -h 0.0.0.0 -f sample/dagster_project/definitions.py
94
+
make dagster-dev
95
+
```
96
+
or
97
+
```bash
98
+
make dev
83
99
```
84
100
85
101
If you'd like to materialize the dagster assets quickly on the CLI:
0 commit comments