Merge pull request #72 from PagerDuty/issue-71-linter-formatter

feat(71): Add a standard chosen linter/formatter, format and fix linter errors

Author: Deconstrained

.circleci/config.yml

@@ -1,24 +1,56 @@
 version: 2.1
 
 test: &test
-  name: Setup Virtualenv, install dependencies and test
+  name: Run tests
   command: |
-    virtualenv .python
-    . .python/bin/activate
-    which python
-    python -V
-    which pip
-    pip -V
     ./test.sh
 
+uv: &uv
+  name: Install uv
+  command: |
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+
+ruff: &ruff
+  name: Install ruff for linting and formatting
+  command: |
+    uv tool install ruff@latest
+
 jobs:
 
+  lint:
+    docker:
+      - image: cimg/python:3.13
+    steps:
+      - checkout
+      - run:
+          <<: *uv
+      - run:
+          <<: *ruff
+      - run:
+          command: |
+            uvx ruff check
+
+  format:
+    docker:
+      - image: cimg/python:3.13
+    steps:
+      - checkout
+      - run:
+          <<: *uv
+      - run:
+          <<: *ruff
+      - run:
+          command: |
+            uvx ruff format --check
+
   py3_6:
     docker:
       - image: cimg/python:3.6
     steps:
       - checkout
       - run:
+          environment:
+            NO_UV: 1
           <<: *test
 
   py3_7:
@@ -27,13 +59,17 @@ jobs:
     steps:
       - checkout
       - run:
+          environment:
+            NO_UV: 1
           <<: *test
 
   py3_8:
     docker:
       - image: cimg/python:3.8
     steps:
       - checkout
+      - run:
+          <<: *uv
       - run:
           <<: *test
 
@@ -42,6 +78,8 @@ jobs:
       - image: cimg/python:3.9
     steps:
       - checkout
+      - run:
+          <<: *uv
       - run:
           <<: *test
 
@@ -50,6 +88,8 @@ jobs:
       - image: cimg/python:3.10
     steps:
       - checkout
+      - run:
+          <<: *uv
       - run:
           <<: *test
 
@@ -58,6 +98,8 @@ jobs:
       - image: cimg/python:3.11
     steps:
       - checkout
+      - run:
+          <<: *uv
       - run:
           <<: *test
 
@@ -66,6 +108,8 @@ jobs:
       - image: cimg/python:3.12
     steps:
       - checkout
+      - run:
+          <<: *uv
       - run:
           <<: *test
 
@@ -74,6 +118,8 @@ jobs:
       - image: cimg/python:3.13
     steps:
       - checkout
+      - run:
+          <<: *uv
       - run:
           <<: *test
 
@@ -89,4 +135,6 @@ workflows:
       - py3_11
       - py3_12
       - py3_13
+      - lint
+      - format
 

CHANGELOG.rst

@@ -1,3 +1,17 @@
+**2025-11-19: 6.1.0: Add uv and ruff and fix errors and formatting**
+
+This release adopts `uv <https://docs.astral.sh/uv/>`_ as the project's chosen package manager and build tool, and `ruff <https://docs.astral.sh/ruff/>`_ as its chosen linter and formatter.
+
+* **Fixes:**
+   * Resolve ``NameError`` in the following methods:
+      * ``RestApiV2Client.api_key_access``
+      * ``RestApiV2Client.iter_history``
+      * ``RestApiV2Client.account_has_ability``
+* **Features:**
+   * Revise the exception message for status 401 Unauthorized to include a suggestion that the service region / base URL are wrong; this is in some use cases the most common reason for the error.
+   * Rewrite the end-to-end package publish testing script to use uv, and perform deeper inspection of the resulting installed package.
+   * New-and-improved development workflow using ``uv`` and ``ruff``
+
 **2025-10-24: 6.0.0: Change base HTTP client to python-httpx**
 
 The underlying HTTP client on which this library is based has been changed to `python-httpx <https://www.python-httpx.org>`_. The primary motivation of this change is to provide thread safety with a very similar interface to ``requests``, and the possibility to add support for asynchronous usage in future releases.

Makefile

@@ -1,19 +1,18 @@
 %: build
 
-build: pagerduty/* pyproject.toml
-	rm -f dist/* && python3 -m build
+build: uv.lock pagerduty/* pyproject.toml
+	rm -f dist/* && uv build
 
 docs/index.html: build pyproject.toml pagerduty/* CHANGELOG.rst sphinx/source/*
-	rm -fr ./docs && cd sphinx && make html && cd .. && mv sphinx/build/html ./docs && touch ./docs/.nojekyll
+	rm -fr ./docs && cd sphinx && uv run make html && cd .. && mv sphinx/build/html ./docs && touch ./docs/.nojekyll
 
-docs: docs/index.html pagerduty/__pycache__
-
-# Require the module be compiled first so metadata can be used:
-pagerduty/__pycache__:
-	pip install .
+docs: docs/index.html build
 
 testpublish: build
-	./publish-test.sh
+	./test/publish-test.sh
 
 publish: build
-	twine upload dist/*.tar.gz dist/*.whl
+	uv publish --username __token__
+
+uv.lock: pyproject.toml
+	uv sync

docs/changelog.html

@@ -76,6 +76,34 @@
 
   <section id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading"></a></h1>
+<p><strong>2025-11-19: 6.1.0: Add uv and ruff and fix errors and formatting</strong></p>
+<p>This release adopts <a class="reference external" href="https://docs.astral.sh/uv/">uv</a> as the project’s chosen package manager and build tool, and <a class="reference external" href="https://docs.astral.sh/ruff/">ruff</a> as its chosen linter and formatter.</p>
+<ul class="simple">
+<li><dl class="simple">
+<dt><strong>Fixes:</strong></dt><dd><ul>
+<li><dl class="simple">
+<dt>Resolve <code class="docutils literal notranslate"><span class="pre">NameError</span></code> in the following methods:</dt><dd><ul>
+<li><p><code class="docutils literal notranslate"><span class="pre">RestApiV2Client.api_key_access</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">RestApiV2Client.iter_history</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">RestApiV2Client.account_has_ability</span></code></p></li>
+</ul>
+</dd>
+</dl>
+</li>
+</ul>
+</dd>
+</dl>
+</li>
+<li><dl class="simple">
+<dt><strong>Features:</strong></dt><dd><ul>
+<li><p>Revise the exception message for status 401 Unauthorized to include a suggestion that the service region / base URL are wrong; this is in some use cases the most common reason for the error.</p></li>
+<li><p>Rewrite the end-to-end package publish testing script to use uv, and perform deeper inspection of the resulting installed package.</p></li>
+<li><p>New-and-improved development workflow using <code class="docutils literal notranslate"><span class="pre">uv</span></code> and <code class="docutils literal notranslate"><span class="pre">ruff</span></code></p></li>
+</ul>
+</dd>
+</dl>
+</li>
+</ul>
 <p><strong>2025-10-24: 6.0.0: Change base HTTP client to python-httpx</strong></p>
 <p>The underlying HTTP client on which this library is based has been changed to <a class="reference external" href="https://www.python-httpx.org">python-httpx</a>. The primary motivation of this change is to provide thread safety with a very similar interface to <code class="docutils literal notranslate"><span class="pre">requests</span></code>, and the possibility to add support for asynchronous usage in future releases.</p>
 <ul class="simple">