alan-turing-institute / data-safe-haven

https://data-safe-haven.readthedocs.io
BSD 3-Clause "New" or "Revised" License
61 stars 15 forks source link

Update installation instructions #2155

Closed jemrobinson closed 2 months ago

jemrobinson commented 2 months ago

:white_check_mark: Checklist

:vertical_traffic_light: Depends on

:arrow_heading_up: Summary

:closed_umbrella: Related issues

Closes #2084

:microscope: Tests

Installation
Usage
Package contents verification /Users/jrobinson/.local/pipx/venvs/data-safe-haven/bin/dsh $ ls -alh /Users/jrobinson/.local/pipx/venvs/data-safe-haven/lib/python3.12/site-packages/data_safe_haven total 32 drwxr-xr-x@ 22 jrobinson staff 704B 22 Aug 17:38 . drwxr-xr-x@ 143 jrobinson staff 4.5K 22 Aug 17:38 .. -rw-r--r--@ 1 jrobinson staff 171B 22 Aug 17:38 __init__.py drwxr-xr-x@ 6 jrobinson staff 192B 22 Aug 17:38 __pycache__ drwxr-xr-x@ 5 jrobinson staff 160B 22 Aug 17:38 administration drwxr-xr-x@ 11 jrobinson staff 352B 22 Aug 17:38 commands drwxr-xr-x@ 11 jrobinson staff 352B 22 Aug 17:38 config drwxr-xr-x@ 7 jrobinson staff 224B 22 Aug 17:38 console -rw-r--r--@ 1 jrobinson staff 684B 22 Aug 17:38 directories.py drwxr-xr-x@ 4 jrobinson staff 128B 22 Aug 17:38 exceptions drwxr-xr-x@ 6 jrobinson staff 192B 22 Aug 17:38 external drwxr-xr-x@ 6 jrobinson staff 192B 22 Aug 17:38 functions drwxr-xr-x@ 8 jrobinson staff 256B 22 Aug 17:38 infrastructure drwxr-xr-x@ 7 jrobinson staff 224B 22 Aug 17:38 logging drwxr-xr-x@ 5 jrobinson staff 160B 22 Aug 17:38 provisioning drwxr-xr-x@ 11 jrobinson staff 352B 22 Aug 17:38 resources drwxr-xr-x@ 7 jrobinson staff 224B 22 Aug 17:38 serialisers -rw-r--r--@ 1 jrobinson staff 496B 22 Aug 17:38 singleton.py drwxr-xr-x@ 7 jrobinson staff 224B 22 Aug 17:38 types drwxr-xr-x@ 5 jrobinson staff 160B 22 Aug 17:38 utility drwxr-xr-x@ 6 jrobinson staff 192B 22 Aug 17:38 validators -rw-r--r--@ 1 jrobinson staff 71B 22 Aug 17:38 version.py ```
Dependency versions
github-actions[bot] commented 2 months ago

Coverage report

This PR does not seem to contain any modification to coverable code.

jemrobinson commented 2 months ago

Is it worth also mentioning that you could install to a venv? (Anyone who wants to do that probably already knows).

Yes, I'll add that too.