Skip to content

Commit f4bb22a

Browse files
committed
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.
1 parent 5333eca commit f4bb22a

File tree

3 files changed

+27
-8
lines changed

3 files changed

+27
-8
lines changed

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ clean:
5151
test:
5252
$(PYTHON_CMD) -m pytest -vv --log-cli-level=INFO $(filter-out $@,$(MAKECMDGOALS))
5353

54+
pyright:
55+
pnpm pyright
56+
5457
# Sample project commands
5558

5659
dagster-dev: clean-dagster

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,21 +55,33 @@ _Note: this is a python project but some of our dependent tools are in typescrip
5555

5656
### Installing
5757

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:
5959

6060
```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
6375
```
6476

6577
### Running tests
6678

6779
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.
6880

69-
We run tests with `pytest` like so:
81+
To run tests:
7082

7183
```bash
72-
poetry run pytest
84+
make test
7385
```
7486

7587
### Running the "sample" dagster project
@@ -79,13 +91,17 @@ accompanying sqlmesh project from `sample/sqlmesh_project` configured as an
7991
asset. To run the sample dagster project deployment with a UI:
8092

8193
```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
8399
```
84100

85101
If you'd like to materialize the dagster assets quickly on the CLI:
86102

87103
```bash
88-
dagster asset materialize -f sample/dagster_project/definitions.py --select '*'
104+
make dagster-materialize
89105
```
90106

91107
_Note: The sqlmesh project that is in the sample folder has a dependency on a

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"scripts": {
1313
"build": "turbo run build --concurrency=100%",
1414
"format:staged": "lint-staged",
15-
"pyright": "pyright --pythonpath $(poetry env info --path)/bin/python",
15+
"pyright": "pyright --pythonpath .venv/bin/python",
1616
"prepare": "husky install"
1717
},
1818
"devDependencies": {

0 commit comments

Comments
 (0)