Change to use pipenv

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: unit-tests
+name: Continuous Integration
 on:
   pull_request:
   merge_group:
@@ -16,11 +16,28 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v5
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - run: python -m venv env
-      - run: source env/bin/activate
-      - run: env/bin/pip install -e .
-      - run: env/bin/pip install pytest
-      - run: env/bin/pytest
+
+      - name: Install pipenv
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install pipenv
+
+      - name: Cache
+        uses: actions/cache@v4
+        id: pipenv-cache
+        with:
+          path: ~/.local/share/virtualenvs
+          key: ${{ runner.os }}-pipenv-${{ hashFiles('**/Pipfile') }}
+          restore-keys: |
+            ${{ runner.os }}-pipenv-${{ hashFiles('**/Pipfile') }}
+
+      - name: Install dependencies
+        if: steps.pipenv-cache.outputs.cache-hit != 'true'
+        run: pipenv install --dev
+
+      - name: Run test
+        run: pipenv run pytest

README.md

@@ -25,14 +25,20 @@ Dicom fields are separated into different groups. Each groups will be anonymized
 
 Installation can be done via pip `pip install dicom-anonymizer` or conda `conda install -c conda-forge dicom-anonymizer`.
 
+
+# Set up for development
+
+Follow these steps once to prepare your development environment.
+
+- Install [pipenv](https://pypi.org/project/pipenv/): `pip install --user pipenv`
+- Create a new virtual environment with Python 3.x.x: `pipenv --python 3.x.x`
+- Install all development dependencies in this environment: `pipenv install --dev`
+
+
 # How to test it?
-- One time set up:
-  - virtual environment for this package and activate it. For
-  example set up using `virtualenv venv` and activate using
-  `venv\Scripts\activate.bat` (on Windows)
-  - Install editable version and development requirements using
-  `pip install -e .[dev]`
-- Run unit test using `pytest`
+
+Tests are written using `pytest`. You can run them using the following command: `pipenv run pytest`
+
 
 # How to build it?
 These instructions rely on wheel build-package format. Install it if you have not done it already using: