@@ -70,11 +70,12 @@ and understanding are greatly appreciated.
70
70
71
71
## Development
72
72
73
- ** higlass-python** is primarily a Python project, but it includes JavaScript for
74
- the anywidget-based front-end code (` src/higlass/widget.js ` ). We use
75
- [ uv] ( https://github.com/astral-sh/uv ) for Python development and
76
- [ deno] ( https://github.com/denoland/deno ) for linting and type-checking
77
- JavaScript.
73
+ ** higlass-python** is a uv workspace monorepo that includes the main library
74
+ and additional packages (e.g., ** higlass-schema** ). It's primarily a Python
75
+ project, but includes JavaScript for the anywidget-based front-end code
76
+ (` src/higlass/widget.js ` ). We use [ uv] ( https://github.com/astral-sh/uv ) for
77
+ Python development and [ deno] ( https://github.com/denoland/deno ) for linting and
78
+ type-checking JavaScript.
78
79
79
80
All formatting, linting, and tests are enforced in CI.
80
81
@@ -84,15 +85,25 @@ All commands are run from the root of the project, from a terminal:
84
85
85
86
#### Python
86
87
88
+ ** Workspace-wide commands** (runs across all packages):
89
+
87
90
| Command | Action |
88
91
| ----------------------------------------------- | --------------------------------------------- |
89
92
| ` uv run jupyter lab ` | Run Jupyter lab with current package state |
90
- | ` uv run ruff check --fix && uv run ruff format ` | Lint and apply formatting |
91
- | ` uv run check ` | Check linting rules |
92
- | ` uv run ruff format --check ` | Check formatting |
93
- | ` uv run pytest ` | Run unit tests |
93
+ | ` uv run ruff check --fix && uv run ruff format ` | Lint and apply formatting across all packages |
94
+ | ` uv run ruff format --check ` | Check formatting across all packages |
95
+ | ` uv run pytest ` | Run unit tests across all packages |
94
96
| ` uv run docs/build.py ` | Build the documentation in ` docs/_build/html ` |
95
97
98
+ ** Package-specific commands** (run a command within a specific package):
99
+
100
+ | Command | Action |
101
+ | ------------------------------------------------ | ------------------------------------ |
102
+ | ` uv run --package higlass-schema pytest ` | Run tests for higlass-schema package |
103
+ | ` uv run --package higlass-schema ruff check ` | Lint higlass-schema package |
104
+ | ` uv run --package higlass-schema ruff format ` | Format higlass-schema package |
105
+ | ` uv run --package higlass-schema higlass-schema ` | Run higlass-schema CLI |
106
+
96
107
#### JavaScript
97
108
98
109
| Command | Action |
0 commit comments