ACMEClient has been moved into gufo.acme.clients.base

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -25,7 +25,7 @@ body:
         should be self-contained, i.e., can be copy-pasted into the Python
         interpreter or run as-is via `python myproblem.py`.
       placeholder: |
-        from gufo.acme.client import ACMEClient
+        from gufo.acme.clients.base import ACMEClient
         << your code here >>
       render: python
     validations:

CHANGELOG.md

@@ -12,6 +12,10 @@ To see unreleased changes, please see the [CHANGELOG on the master branch](https
 
 ## [Unreleased]
 
+## Changed
+
+* ACMEClient has been moved into `gufo.acme.clients.base`.
+
 ## Fixed
 
 * Fixed typo in exception class name.

examples/acme_register.py

@@ -1,7 +1,7 @@
 import asyncio
 import sys
 
-from gufo.acme.client import ACMEClient
+from gufo.acme.clients.base import ACMEClient
 
 DIRECTORY = "https://acme-staging-v02.api.letsencrypt.org/directory"
 

examples/acme_sign.py

@@ -2,7 +2,7 @@
 import os
 import sys
 
-from gufo.acme.client import ACMEClient
+from gufo.acme.clients.base import ACMEClient
 from gufo.acme.types import ACMEChallenge
 
 CHALLENGE_DIR = "/www/acme/"

examples/get_csr.py

@@ -1,6 +1,6 @@
 import sys
 
-from gufo.acme.client import ACMEClient
+from gufo.acme.clients.base import ACMEClient
 
 
 def main(domain: str, private_key_path: str, csr_path: str) -> None:

examples/get_private_key.py

@@ -1,6 +1,6 @@
 import sys
 
-from gufo.acme.client import ACMEClient
+from gufo.acme.clients.base import ACMEClient
 
 
 def main(path: str) -> None:

src/gufo/acme/__init__.py

@@ -12,7 +12,7 @@
 The package consists of the following modules:
 
 * [acme][gufo.acme.acme] - ACME protocol messages.
-* [client][gufo.acme.client] - ACMEClient implementation.
+* [clients][gufo.acme.clients] - Various ACME clients imlementations.
 * [error][gufo.acme.error] - Error classes.
 * [log][gufo.acme.log] - Logging utilities.
 * [types][gufo.acme.types] - Package public types.

src/gufo/acme/clients/__init__.py

@@ -0,0 +1,13 @@
+# ---------------------------------------------------------------------
+# Gufo ACME: Various clients implementation.
+# ---------------------------------------------------------------------
+# Copyright (C) 2023, Gufo Labs
+# ---------------------------------------------------------------------
+
+"""
+Various ACME clients implementations.
+
+The following clients are provided out-of-the-box:
+
+* [base
+"""

src/gufo/acme/client.py → src/gufo/acme/clients/base.py

@@ -41,9 +41,9 @@
 from josepy.jwk import JWK, JWKRSA
 
 # Gufo ACME modules
-from . import __version__
-from .acme import AcmeJWS
-from .error import (
+from .. import __version__
+from ..acme import AcmeJWS
+from ..error import (
     ACMEAlreadyRegistered,
     ACMEAuthorizationError,
     ACMEBadNonceError,
@@ -57,8 +57,8 @@
     ACMEUnauthorizedError,
     ACMEUndecodableError,
 )
-from .log import logger
-from .types import ACMEAuthorization, ACMEChallenge, ACMEDirectory, ACMEOrder
+from ..log import logger
+from ..types import ACMEAuthorization, ACMEChallenge, ACMEDirectory, ACMEOrder
 
 BAD_REQUEST = 400
 T = TypeVar("T")

tests/test_client.py

@@ -16,7 +16,7 @@
 import pytest
 
 # CSR Proxy modules
-from gufo.acme.client import ACMEClient
+from gufo.acme.clients.base import ACMEClient
 from gufo.acme.error import (
     ACMEAlreadyRegistered,
     ACMEBadNonceError,