Skip to content

Commit b146655

Browse files
committed
Update README with unified documentation
1 parent 69aa655 commit b146655

File tree

5 files changed

+1352
-1335
lines changed

5 files changed

+1352
-1335
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,12 @@ and understanding are greatly appreciated.
7070

7171
## Development
7272

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.
7879

7980
All formatting, linting, and tests are enforced in CI.
8081

@@ -84,15 +85,25 @@ All commands are run from the root of the project, from a terminal:
8485

8586
#### Python
8687

88+
**Workspace-wide commands** (runs across all packages):
89+
8790
| Command | Action |
8891
| ----------------------------------------------- | --------------------------------------------- |
8992
| `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 |
9496
| `uv run docs/build.py` | Build the documentation in `docs/_build/html` |
9597

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+
96107
#### JavaScript
97108

98109
| Command | Action |

packages/higlass-schema/README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,13 @@ Pydantic models for HiGlass
99
pip install higlass-schema
1010
```
1111

12-
🚧 👷
13-
14-
1512
## Development
1613

1714
Try it out:
1815

1916
```bash
20-
$ uvx --no-cache --from . higlass-schema check ./example.json # [--verbose]
21-
$ uvx --no-cache --from . higlass-schema export # prints JSON schema to stdout
17+
$ uv run higlass-schema check ./example.json # [--verbose]
18+
$ uv run higlass-schema export # prints JSON schema to stdout
2219
```
2320

2421
Testing, linting, & formatting are enforced in CI. Locally, you can run:
@@ -28,10 +25,3 @@ uv run pytest # tests
2825
uv run ruff check # linting
2926
uv run ruff format --check # formatting (remove --check to apply)
3027
```
31-
32-
## Release
33-
34-
```bash
35-
git tag -a v0.0.0 -m "v0.0.0"
36-
git push --follow-tags
37-
```

packages/higlass-schema/pyproject.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@ homepage = "https://github.com/higlass/higlass-schema"
1414
[project.scripts]
1515
higlass-schema = "higlass_schema.cli:main"
1616

17-
[dependency-groups]
18-
dev = ["pytest", "ruff"]
19-
2017
[build-system]
2118
requires = ["uv_build>=0.8.0,<0.9"]
2219
build-backend = "uv_build"

pyproject.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,14 @@ extend-select = [
6060
"F811", # redefintion
6161
]
6262

63+
[tool.uv]
64+
required-version = ">=0.8.0,<0.9.0"
65+
66+
[tool.uv.build-backend]
67+
module-name = "higlass"
68+
6369
[tool.uv.workspace]
6470
members = ["packages/*"]
71+
72+
[tool.uv.sources]
73+
higlass-schema = { workspace = true }

0 commit comments

Comments
 (0)