Skip to content

Commit c486cb3

Browse files
committed
Renamed dev scripts in tools folder.
Specifically, the `types.py` script would occasionally cause issues as it shadows `types` module from the standard library.
1 parent 63084ea commit c486cb3

File tree

12 files changed

+18
-28
lines changed

12 files changed

+18
-28
lines changed

.github/workflows/check_commit.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737
run: uv run basedpyright
3838

3939
- name: Run tests.
40-
run: uv run tools/test.py config
40+
run: uv run tools/run_tests.py config
4141
# We only run the very small part of the test suite that doesn't
4242
# require Comsol to be installed. This essentially just tests that
4343
# the library can be successfully imported, but not much more.

tests/ReadMe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Test suite
22

33
The scripts here, along with some fixtures, constitute the test suite. They are
4-
run in the intended order by the helper script `test.py` in the `tools` folder,
5-
typically with `uv run tools/test.py`.
4+
run in the intended order by the helper script `run_tests.py` in the `tools`
5+
folder, typically with `uv run tools/run_tests.py`.

tools/ReadMe.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,18 @@ environment in the `.venv` folder with all dependencies installed in it, as
1919
defined in `pyproject.toml`.
2020

2121
Run any of the dev tools via the helper scripts in the `tools` folder. For
22-
example `uv run tools/lint.py` to lint the code (same as `uv run ruff check`),
23-
`uv run tools/types.py` to check types, etc.
22+
example `uv run tools/lint_code.py` to lint the code for quality issues (same
23+
as `uv run ruff check`), `uv run tools/check_types.py` to check type
24+
annotations, etc.
2425

25-
You may also install into an existing virtual environment or even the global
26-
Python environment with `uv pip install --editable .`. The `--editable` flag
27-
makes it so that all code changes take immediate effect without re-installing
28-
the package.
26+
Alternatively, you may also install from source into an existing virtual
27+
environment or even the global Python environment with `uv pip install --group
28+
dev --editable .`. The `--editable` flag makes it so that all code changes take
29+
immediate effect without re-installing the package.
2930

3031
When using Pip, follow the standard workflow: Create a virtual Python
3132
environment `python -m venv .venv`, activate it, and install the project in it
32-
with `pip install --editable .`
33+
with `pip install --group dev --editable .`
3334

3435
[UV]: https://docs.astral.sh/uv
3536
[Pip]: https://pip.pypa.io
@@ -42,17 +43,17 @@ with `pip install --editable .`
4243
- Tag commit with version number, e.g. `git tag v1.3.0`
4344
- Force `stable` branch to latest commit: `git branch -f stable`
4445
- Same for the current documentation branch: `git branch -f 1.3`
45-
- Run code linter: `uv run tools/lint.py`
46-
- Test docs build: `un run tools/docs.py`
47-
- Test wheel build: `uv run tools/wheel.py`
48-
- Run code coverage: `uv run tools/coverage.py`
46+
- Run code linter: `uv run tools/lint_code.py`
47+
- Test docs build: `un run tools/render_docs.py`
48+
- Test wheel build: `uv run tools/build_wheel.py`
49+
- Run code coverage: `uv run tools/measure_coverage.py`
4950
- Push to GitHub:
5051
```
5152
git push origin main
5253
git push --tags
5354
git push origin stable
5455
git push origin 1.3
5556
```
56-
- Upload coverage report: `uv run tools/codecov.py`
57+
- Upload coverage report: `uv run tools/report_codecov.py`
5758
- Create new release on GitHub and add release notes.
58-
- Publish to PyPI: `uv run tools/publish.py`
59+
- Publish to PyPI via GitHub Action.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

tools/publish.py

Lines changed: 0 additions & 11 deletions
This file was deleted.
File renamed without changes.

0 commit comments

Comments
 (0)