From 20c59c9ce9f7ac68f82d8a6e4137f644204e132d Mon Sep 17 00:00:00 2001 From: sethg Date: Sun, 31 May 2026 12:26:05 +0200 Subject: [PATCH] Update dev setup docs to pyproject.toml --- README.md | 2 +- docs/source/development.rst | 43 +++++++++++++++++++++++++++++++------ 2 files changed, 38 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f8656295..5ed60aeb 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ pip3 install OWSLib ### Dependencies -Dependencies are listed in [requirements.txt](requirements.txt). Dependencies +Dependencies are listed in [pyproject.toml](pyproject.toml). Dependencies are automatically installed during OWSLib installation. ### Installing OWSLib diff --git a/docs/source/development.rst b/docs/source/development.rst index 5198d9eb..81d8fde4 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -10,14 +10,45 @@ You can find out about software metrics at the OWSLib OpenHub page at https://ww Testing ------- +Create a virtual environment and install OWSLib with the development dependencies: + .. code-block:: bash - # install requirements - pip3 install -r requirements.txt - pip3 install -r requirements-dev.txt # needed for tests only + python3 -m venv owslibenv + source owslibenv/bin/activate + + git clone https://github.com/geopython/OWSLib.git + cd OWSLib + + pip install -e ".[dev]" + +Run the test suite: + +.. code-block:: bash - # run tests python3 -m pytest - # linting - flake8 owslib/wmts.py +Run linting: + +.. code-block:: bash + + flake8 owslib/ + +Documentation +------------- + +To build the documentation locally: + +.. code-block:: bash + + pip install -e ".[docs]" + cd docs && make html + +Release +------- + +To install the release tooling: + +.. code-block:: bash + + pip install -e ".[release]"