You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-44Lines changed: 17 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@
17
17
18
18
</h4>
19
19
20
-
The BAM Masterdata is a repository containing all the masterdata schema defining in BAM, as well as some utility functions to handle the masterdata.
20
+
The BAM Masterdata repository contains the masterdata schemas defined at BAM and provides utility functions for working with them.
21
21
22
22
If you want to install it, do:
23
23
```sh
@@ -40,14 +40,18 @@ python3 -m venv .venv
40
40
source .venv/bin/activate
41
41
```
42
42
43
-
Run the following script for Linux or MacOS:
44
-
```sh
45
-
./scripts/install_python_dependencies
46
-
```
47
-
or for Windows:
48
-
```sh
49
-
scripts/install_python_dependencies.bat
50
-
```
43
+
Run the following script depending on your OS:
44
+
-*Linux/MacOS*:
45
+
```sh
46
+
./scripts/install_python_dependencies.sh
47
+
```
48
+
-*Windows*:
49
+
```sh
50
+
scripts/install_python_dependencies.bat
51
+
```
52
+
53
+
**Note**: This script installs the required dependencies for development, testing, and documentation, using `uv` and `pip`.
54
+
51
55
### Run the tests
52
56
53
57
You can locally run the tests by doing:
@@ -75,53 +79,22 @@ ruff check .
75
79
This will produce an output with the specific issues found. In order to auto-fix them, run:
76
80
77
81
```sh
78
-
ruff format . --check
82
+
ruff format .
79
83
```
80
84
81
85
If some issues are not possible to fix automatically, you will need to visit the file and fix them by hand.
82
86
83
-
### Run the local website
84
-
85
-
**Under construction!**
86
-
87
-
<!-- ### Debugging
88
-
89
-
For interactive debugging of the tests, use `pytest` with the `--pdb` flag. We recommend using an IDE for debugging, e.g., _VSCode_. If that is the case, add the following snippet to your `.vscode/launch.json`:
where `<path-to-plugin-tests>` must be changed to the local path to the test module to be debugged.
114
-
115
-
The settings configuration file `.vscode/settings.json` automatically applies the linting and formatting upon saving the modified file. -->
116
87
117
88
### Documentation on Github pages
118
89
119
-
To view the documentation locally, make sure to have installed the extra packages (this is part of the `scripts/install_python_dependencies.sh`, so if you ran this script before, you don't need to do it again now):
90
+
To view the documentation locally, make sure to have installed the extra packages (this is part of the `scripts/install_python_dependencies.*`, so if you ran this script before, you don't need to do it again now):
120
91
121
92
```sh
122
93
uv pip install -e '[docu]'
123
94
```
124
95
96
+
**Note**: This command installs `mkdocs`, `mkdocs-material`, and other documentation-related dependencies.
0 commit comments