Skip to content

Commit c7289b7

Browse files
committed
Update local development setup instructions
1 parent 16a3b2a commit c7289b7

File tree

1 file changed

+38
-8
lines changed

1 file changed

+38
-8
lines changed

README.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,44 @@ Dicom fields are separated into different groups. Each groups will be anonymized
2525

2626
Installation can be done via pip `pip install dicom-anonymizer` or conda `conda install -c conda-forge dicom-anonymizer`.
2727

28-
# How to test it?
29-
- One time set up:
30-
- virtual environment for this package and activate it. For
31-
example set up using `virtualenv venv` and activate using
32-
`venv\Scripts\activate.bat` (on Windows)
33-
- Install editable version and development requirements using
34-
`pip install -e .[dev]`
35-
- Run unit test using `pytest`
28+
29+
# Local Development Setup
30+
31+
To get started with local development, follow these steps:
32+
33+
1. Create a Virtual Environment:
34+
- On Windows:
35+
```sh
36+
virtualenv env
37+
.\env\Scripts\activate.bat
38+
```
39+
- On MacOS/Linux:
40+
```sh
41+
python -m venv env
42+
source env/bin/activate
43+
```
44+
45+
2. Install Dependencies:
46+
- Install an editable version of the package and the development requirements:
47+
```sh
48+
pip install -e .[dev]
49+
```
50+
51+
3. Set Up Pre-Commit Hooks:
52+
- Install the pre-commit hooks to ensure code quality:
53+
```sh
54+
pre-commit install
55+
```
56+
57+
58+
## How to test it?
59+
60+
To run the unit tests, use the following command:
61+
62+
```sh
63+
pytest
64+
```
65+
3666

3767
# How to build it?
3868
These instructions rely on wheel build-package format. Install it if you have not done it already using:

0 commit comments

Comments
 (0)