Skip to content

Commit 57be724

Browse files
committed
Fixed README with more info on the script, uv
1 parent c0e6553 commit 57be724

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,16 @@ python3.9 -m venv .pyenv
2121
. .pyenv/bin/activate
2222
```
2323

24+
We recommend installing `uv` for fast pip installation of the packages:
25+
```sh
26+
pip install uv
27+
```
28+
2429
Install the `nomad-lab` package:
2530

2631
```sh
2732
pip install --upgrade pip
28-
pip install '.[dev]' --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
33+
uv pip install '.[dev]' --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
2934
```
3035

3136
**Note!**
@@ -37,7 +42,7 @@ sure to include NOMAD's internal package registry (via `--index-url` in the abov
3742
You can run local tests using the `pytest` package:
3843

3944
```sh
40-
python -m pytest -sv
45+
python -m pytest -sv tests
4146
```
4247

4348
where the `-s` and `-v` options toggle the output verbosity.
@@ -46,15 +51,20 @@ Our CI/CD pipeline produces a more comprehensive test report using `coverage` an
4651

4752
```sh
4853
pip install coverage coveralls
49-
python -m pytest --cov=src
54+
python -m pytest --cov=src tests
55+
```
56+
57+
You can also run the script to generate a local file `coverage.txt` with the same information by doing:
58+
```sh
59+
./scripts/generate_coverage_txt.sh
5060
```
5161

5262
## Development
5363

5464
The plugin is still under development. If you would like to contribute, install the package in editable mode (with the added `-e` flag) with the development dependencies:
5565

5666
```sh
57-
pip install -e .[dev] --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
67+
uv pip install -e .[dev] --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
5868
```
5969

6070
### Setting up plugin on your local installation

scripts/generate_coverage_txt.sh

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,4 @@
44
python -m pytest --cov=src | tee coverage.txt
55

66
# Append the generation message
7-
echo " " >> coverage.txt
8-
echo " " >> coverage.txt
9-
echo -e "\n\nGenerated using './scripts/generate_coverage_txt.sh' in the terminal in the root folder of the project" >> coverage.txt
7+
echo -e "\n\n\nGenerated using './scripts/generate_coverage_txt.sh' in the terminal in the root folder of the project" >> coverage.txt

0 commit comments

Comments
 (0)