Prepare release v1.0.2

Author: mesudip

README.md

@@ -1,14 +1,15 @@
-# CertApi
+CertApi
+=============================
 
-CertApi is a Python package for requesting SSL certificates from ACME.
-This is to be used as a base library for building other tools, or to integrate Certificate creation feature in you app.
+Certapi talks with DNS provider and ACME to issue SSL certificates and save it to a keystore.
+
+CertApi is a base library for building other tools, or to integrate Certificate creation feature in your app. CertAPI also provides HTTP api server and can be deployed using Docker
 
 [![Build Status](https://github.com/mesudip/certapi/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/mesudip/certapi/actions/workflows/tests.yml)
 [![codecov](https://codecov.io/github/mesudip/certapi/graph/badge.svg?token=NYTNCH29IT)](https://codecov.io/github/mesudip/certapi)
 [![PyPI version](https://img.shields.io/pypi/v/certapi.svg)](https://pypi.org/project/certapi/)
 
 
-For a detailed list of changes, please refer to the [CHANGELOG.md](CHANGELOG.md).
 
 ## Installation
 
@@ -76,12 +77,11 @@ cert_manager = AcmeCertManager(
     key_store=key_store,
     cert_issuer=cert_issuer,
     challenge_solvers=[dns_solver], # other solvers can be used
-    renew_threshold_days=7
-)
+    )
 cert_manager.setup()
 
 # 4. Issue or Reuse Certificate
-# Automatically checks keystore and renews only if necessary
+# Automatically checks sand saves to keystore. Renews only if necessary.
 response = cert_manager.issue_certificate(["example.com", "www.example.com"])
 
 for cert_data in response.issued:

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="certapi",
-    version="1.0.0",
+    version="1.0.2",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
     install_requires=[

src/app.py

@@ -79,13 +79,13 @@ def acme_challenge(cid):
 def handle_certapi_error(error: CertApiException):
     print(f"CertApiException [{error.__class__.__name__}]: {error}", file=sys.stderr)
     print_filtered_traceback(error)
-    
+
     status = 400
     if isinstance(error, AcmeHttpError):
         status = error.response.status_code
         if status == 200:
             status = 400
-            
+
     return error.json_obj(), status
 
 

src/certapi/acme/AcmeError.py

@@ -32,7 +32,6 @@ def __init__(self, response: requests.Response, step: str):
         AcmeError.__init__(self, message, detail, step)
         self.response = response
 
-
     def extract_acme_response_error(self):
         message = None
         error = None
@@ -44,12 +43,12 @@ def extract_acme_response_error(self):
                     if not invalid_challenges:
                         # Fallback if no invalid challenge found but status is invalid
                         return (None, res_json)
-                        
+
                     failed_challenge: dict = invalid_challenges[0]
                     error = failed_challenge.get("error")
                     if not error:
                         return (None, res_json)
-                        
+
                     err_detail: str = error.get("detail", "")
                     err_type: str = error.get("type", "")
                     validation_record: dict = failed_challenge.get("validationRecord")
@@ -70,7 +69,9 @@ def extract_acme_response_error(self):
                             error["dns"] = {"error": error}
                             message = err_detail
                     else:
-                        validation_record = validation_record[0] if isinstance(validation_record, list) and validation_record else {}
+                        validation_record = (
+                            validation_record[0] if isinstance(validation_record, list) and validation_record else {}
+                        )
                         error["hostname"] = validation_record.get("hostname", "unknown")
                         error["dns"] = {
                             "resolved": validation_record.get("addressesResolved"),

src/certapi/client/__init__.py

@@ -1 +1 @@
-from .cert_manager_client import CertManagerClient
+from .cert_manager_client import CertManagerClient

src/certapi/server/api.py

@@ -91,7 +91,12 @@ def create_api_resources(api_ns, cert_manager: AcmeCertManager, renew_queue_size
     obtain_parser.add_argument("organization", type=str, help="Organization name")
     obtain_parser.add_argument("user_id", type=str, help="User ID")
     obtain_parser.add_argument("renew_threshold_days", type=int, help="Threshold in days for certificate reuse")
-    obtain_parser.add_argument("skip_failing", type=inputs.boolean, default=False, help="Allow issuance to proceed if some domains fail verification")
+    obtain_parser.add_argument(
+        "skip_failing",
+        type=inputs.boolean,
+        default=False,
+        help="Allow issuance to proceed if some domains fail verification",
+    )
 
     @api_ns.route("/obtain")
     class ObtainCert(Resource):
@@ -114,7 +119,7 @@ def get(self):
                     for solver in reversed(cert_manager.challenge_solvers):
                         if solver.supports_domain_strict(h):
                             verified_hostnames.append(h)
-                
+
                 hostnames = verified_hostnames
 
                 if not hostnames and not skip_failing:
@@ -134,7 +139,7 @@ def get(self):
                     user_id=args["user_id"],
                     renew_threshold_days=args.get("renew_threshold_days"),
                 )
-                
+
                 print(data)
                 if data:
                     res_json = data.to_json()