Moves docs build dependencies to pyproject.toml. Updates readme Closes:#61

Author: sjoerdk

.readthedocs.yaml

@@ -4,7 +4,7 @@
 # Required
 version: 2
 
-# Set the version of Python and other tools you might need
+# Set the version of Python and other tools you might need.
 build:
   os: ubuntu-22.04
   tools:
@@ -13,7 +13,8 @@ build:
 mkdocs:
   configuration: mkdocs.yml
 
-# Optionally declare the Python requirements required to build your docs
+# Declare the Python requirements required to build your docs.
 python:
   install:
-  - requirements: docs/docs_requirements.txt
+    - method: pip
+    - extra_requirements: docs

README.md

@@ -38,4 +38,4 @@ trolley.download(studies[0], output_dir='/tmp/trolley')
 ```
 
 ## Documentation
-see [dicomtrolley docs on readthedocs.io](https://dicomtrolley.readthedocs.io)
+See [dicomtrolley docs on readthedocs.io](https://dicomtrolley.readthedocs.io)

docs/contributing.md

@@ -50,13 +50,15 @@ To bump dicomtrolley's version, do the following:
 Docs are based on [mkdocs](https://www.mkdocs.org/), using the 
 [Materials for mkdocs](https://squidfunk.github.io/mkdocs-material/) skin.
 
-Docs are published on [readthedocs.org](https://about.readthedocs.com/). Docs requirements are kept separate and updated with 
-[pip-tools](https://pypi.org/project/pip-tools/) for a clean readthedocs build. To edit the docs:
+Docs are published on [readthedocs.org](https://about.readthedocs.com/). Docs build requirements are in 
+pyproject.toml in the dependency-group `docs`. 
 
-* Install docs dependencies: `pip install -r docs/docs_requirements.txt`
+To edit the docs:
 
-* Edit content in `/docs`, potentialy add requirements in `docs/docs_requirements.in`
+* Install docs dependencies: `uv sync --group docs` (by default uv sync does _not_ install the docs group)
+
+* Edit content in `/docs`
 
 * Try out your changes using `mkdocs serve`
 
-* Update docs requirements (readthedocs needs this): `pip-compile docs/docs_requirements.in`
+* To add docs requirements: `uv add --group dev <package to add>`. To remove `uv remove --group dev <package to add>` 

docs/docs_requirements.in

@@ -1,10 +1,8 @@
 # dicomtrolley
 
-
-[![CI](https://github.com/sjoerdk/dicomtrolley/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/sjoerdk/dicomtrolley/actions/workflows/build.yml?query=branch%3Amaster)
+[![CI](https://github.com/sjoerdk/dicomtrolley/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/sjoerdk/dicomtrolley/actions/workflows/build.yml?query=branch%3Amain)
 [![PyPI](https://img.shields.io/pypi/v/dicomtrolley)](https://pypi.org/project/dicomtrolley/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dicomtrolley)](https://pypi.org/project/dicomtrolley/)
-[![Code Climate](https://codeclimate.com/github/sjoerdk/dicomtrolley/badges/gpa.svg)](https://codeclimate.com/github/sjoerdk/dicomtrolley)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 
@@ -14,7 +12,9 @@ Retrieve medical images via WADO-URI, WADO-RS, QIDO-RS, MINT, RAD69 and DICOM-QR
 * Query and download DICOM Studies, Series and Instances
 * Integrated search and download - automatic queries for missing series and instance info
 
-![A trolley](resources/trolley.png)
+![A trolley](docs/resources/trolley.png)
+
+[dicomtrolley docs on readthedocs.io](https://dicomtrolley.readthedocs.io)
 
 ## Installation
 ```
@@ -36,22 +36,6 @@ studies = trolley.find_studies(Query(PatientName='B*'))
 # download the fist one (using WADO)
 trolley.download(studies[0], output_dir='/tmp/trolley')
 ```
-## Documentation
-see [dicomtrolley docs on readthedocs.io](https://dicomtrolley.readthedocs.io)
-
-## Examples
-Example code can be found [on github](https://github.com/sjoerdk/dicomtrolley/tree/master/examples)
 
-## Alternatives
-* [dicomweb-client](https://github.com/MGHComputationalPathology/dicomweb-client) - Active library supporting QIDO-RS, WADO-RS and STOW-RS. 
-* [pynetdicom](https://github.com/pydicom/pynetdicom) - dicomtrolley's DICOM-QR support is based on pynetdicom. Pynetdicom supports a broad range of DICOM networking interactions and can be used as a stand alone application.
-
-## Caveats
-Dicomtrolley has been developed for and tested on a Vitrea Connection 8.2.0.1 system. This claims to
-be consistent with WADO and MINT 1.2 interfaces, but does not implement all parts of these standards. 
-
-Certain query parameter values and restraints might be specific to Vitrea Connection 8.2.0.1. For example,
-the exact list of DICOM elements that can be returned from a query might be different for different servers.
-
-## Contributing
-See [Contributing](contributing.md)
+## Documentation
+See [dicomtrolley docs on readthedocs.io](https://dicomtrolley.readthedocs.io)

docs/docs_requirements.txt

@@ -24,23 +24,32 @@ Changelog = "https://github.com/sjoerdk/dicomtrolley/blob/main/HISTORY.md"
 line-length = 79
 target-version = ['py310']
 
+[tool.uv.sources]
+dicomtrolley = { workspace = true }
+
 [dependency-groups]
 dev = [
     "pytest>=7.4.0",
     "pytest-randomly>=3.5.0",
     "pytest-cov>=2.11.1",
     "tox>=3.23.0",
-    "requests-mock>=1.11.0",
     "factory-boy>=3.2.1",
     "sybil>=5.0.3",
-    "mkdocs>=1.5.2",
-    "mkdocstrings>=0.22.0",
+    "pre-commit",
+    "requests-mock>=1.12.1",
+]
+docs = [
+    "dicomtrolley",
+    "markdown-mdantic>=2.1.1",
+    "mkdocs>=1.6.1",
+    "mkdocs-autorefs>=1.4.3",
     "mkdocs-gen-files>=0.5.0",
-    "mkdocs-section-index>=0.3.5",
-    "mkdocs-literate-nav>=0.6.0",
-    "markdown-mdantic>=1.3.5",
-    "mkdocs-material>=9.2.8",
-    "mkdocs-autorefs>=0.5.0",
-    "pip-tools>=7.3.0",
-    "pre-commit"
+    "mkdocs-literate-nav>=0.6.2",
+    "mkdocs-material>=9.6.20",
+    "mkdocs-material-extensions>=1.3.1",
+    "mkdocs-section-index>=0.3.10",
+    "mkdocstrings>=0.30.0",
+    "mkdocstrings-python>=1.18.2",
+    "pydantic>=2.11.9",
+    "pydicom>=3.0.1",
 ]