preparing for alpha release

Author: maxkahan

http_client/BUILD

@@ -1,11 +1,16 @@
 resource(name='pyproject', source='pyproject.toml')
+file(name='readme', source='README.md')
 
 files(sources=['tests/data/*'])
 
 python_distribution(
     name='vonage-http-client',
-    dependencies=[':pyproject', 'http_client/src/http_client', 'utils/src/utils'],
+    dependencies=[
+        ':pyproject',
+        ':readme',
+        'http_client/src/vonage_http_client:http_client',
+    ],
     provides=python_artifact(),
     generate_setup=False,
-    repositories=['https://test.pypi.org/legacy/'],
+    repositories=['@pypi'],
 )

http_client/README.md

@@ -1,17 +1,60 @@
-# Need to redo this to be about the client!
+# Vonage HTTP Client Package
 
-Vonage Authentication Package
+This Python package provides a synchronous HTTP client for sending authenticated requests to Vonage APIs.
 
-`vonage-auth` provides a convenient way to handle authentication related to Vonage APIs in your Python projects. This package includes an `Auth` class that allows you to manage API key- and secret-based authentication as well as JSON Web Token (JWT) authentication.
+This package (`vonage-http-client`) is used by the `vonage` Python package and SDK so doesn't require manual installation or config unless you're using this package independently of a SDK.
 
-This package (`vonage-auth`) is used by the `vonage` Python package so doesn't require manual installation unless you're not using that.
+The `HttpClient` class is initialized with an instance of the `Auth` class for credentials, an optional class of HTTP client options, and an optional SDK version (this is provided automatically when using this module via an SDK).
+
+The `HttpClientOptions` class defines the options for the HTTP client, including the API and REST hosts, timeout, pool connections, pool max size, and max retries.
+
+This package also includes an `Auth` class that allows you to manage API key- and secret-based authentication as well as JSON Web Token (JWT) authentication.
 
 For full API documentation refer to the [Vonage Developer documentation](https://developer.vonage.com).
 
-## Installation
+## Installation (if not using via an SDK)
 
 You can install the package using pip:
 
 ```bash
-pip install vonage-auth
+pip install vonage-http-client
 ```
+
+## Usage
+
+```python
+from vonage_http_client import HttpClient, HttpClientOptions
+from vonage_http_client.auth import Auth
+
+# Create an Auth instance
+auth = Auth(api_key='your_api_key', api_secret='your_api_secret')
+
+# Create HttpClientOptions instance
+options = HttpClientOptions(api_host='api.nexmo.com', timeout=30)
+
+# Create a HttpClient instance
+client = HttpClient(auth=auth, http_client_options=options)
+
+# Make a GET request
+response = client.get(host='api.nexmo.com', request_path='/v1/messages')
+
+# Make a POST request
+response = client.post(host='api.nexmo.com', request_path='/v1/messages', params={'key': 'value'})
+```
+
+### Appending to the User-Agent Header
+
+The HttpClient class also supports appending additional information to the User-Agent header via the append_to_user_agent method:
+
+```python
+client.append_to_user_agent('additional_info')
+```
+
+### Changing the Authentication Method Used
+
+The `HttpClient` class automatically handles JWT and basic authentication based on the Auth instance provided. It uses JWT authentication by default, but you can specify the authentication type when making a request:
+
+```python
+# Use basic authentication for this request
+response = client.get(host='api.nexmo.com', request_path='/v1/messages', auth_type='basic')
+```

http_client/pyproject.toml

@@ -1,14 +1,14 @@
 [project]
-name = 'vonage-http-client'
-version = '0.1.0'
-description = 'An HTTP client for making requests to Vonage APIs.'
+name = "vonage-http-client"
+version = "1.0.0"
+description = "An HTTP client for making requests to Vonage APIs."
 readme = "README.md"
 authors = [{ name = "Vonage", email = "devrel@vonage.com" }]
 requires-python = ">=3.8"
 dependencies = [
-  "vonage-utils>=0.1.0",
+  "vonage-utils>=1.0.0",
   "vonage-jwt>=1.1.0",
-  "requests==2.*",
+  "requests>=2.27.0",
   "pydantic>=2.6.1",
   "typing_extensions>=4.9.0",
 ]
@@ -24,7 +24,7 @@ classifiers = [
 ]
 
 [project.urls]
-homepage = "https://github.com/Vonage/vonage-python-sdk"
+Homepage = "https://github.com/Vonage/vonage-python-sdk"
 
 [build-system]
 requires = ["setuptools>=61.0", "wheel"]

http_client/src/http_client/BUILD renamed to http_client/src/vonage_http_client/BUILD

@@ -1,7 +1,7 @@
 from json import JSONDecodeError
 
 from requests import Response
-from utils.errors import VonageError
+from vonage_utils.errors import VonageError
 
 
 class JWTGenerationError(VonageError):

http_client/src/http_client/__init__.py renamed to http_client/src/vonage_http_client/__init__.py

@@ -2,19 +2,19 @@
 from platform import python_version
 from typing import Literal, Optional, Union
 
-from http_client.auth import Auth
-from http_client.errors import (
+from pydantic import BaseModel, Field, ValidationError, validate_call
+from requests import Response
+from requests.adapters import HTTPAdapter
+from requests.sessions import Session
+from typing_extensions import Annotated
+from vonage_http_client.auth import Auth
+from vonage_http_client.errors import (
     AuthenticationError,
     HttpRequestError,
     InvalidHttpClientOptionsError,
     RateLimitedError,
     ServerError,
 )
-from pydantic import BaseModel, Field, ValidationError, validate_call
-from requests import Response
-from requests.adapters import HTTPAdapter
-from requests.sessions import Session
-from typing_extensions import Annotated
 
 logger = getLogger('vonage')
 

http_client/src/http_client/auth.py renamed to http_client/src/vonage_http_client/auth.py

@@ -1,10 +1,10 @@
 from os.path import dirname, join
 from unittest.mock import patch
 
-from http_client.auth import Auth
-from http_client.errors import InvalidAuthError, JWTGenerationError
 from pydantic import ValidationError
 from pytest import raises
+from vonage_http_client.auth import Auth
+from vonage_http_client.errors import InvalidAuthError, JWTGenerationError
 from vonage_jwt.jwt import JwtClient
 
 
@@ -81,14 +81,14 @@ def vonage_jwt_mock(self):
 
 def test_generate_application_jwt():
     auth = Auth(application_id=application_id, private_key=private_key)
-    with patch('http_client.auth.Auth.generate_application_jwt', vonage_jwt_mock):
+    with patch('vonage_http_client.auth.Auth.generate_application_jwt', vonage_jwt_mock):
         jwt = auth.generate_application_jwt()
     assert jwt == test_jwt
 
 
 def test_create_jwt_auth_string():
     auth = Auth(application_id=application_id, private_key=private_key)
-    with patch('http_client.auth.Auth.generate_application_jwt', vonage_jwt_mock):
+    with patch('vonage_http_client.auth.Auth.generate_application_jwt', vonage_jwt_mock):
         header_auth_string = auth.create_jwt_auth_string()
         assert header_auth_string == b'Bearer ' + test_jwt
 

http_client/src/http_client/errors.py renamed to http_client/src/vonage_http_client/errors.py

@@ -2,19 +2,19 @@
 from os.path import abspath, dirname, join
 
 import responses
-from http_client.auth import Auth
-from http_client.errors import (
+from pytest import raises
+from requests import Response
+from vonage_http_client.auth import Auth
+from vonage_http_client.errors import (
     AuthenticationError,
     HttpRequestError,
     InvalidHttpClientOptionsError,
     RateLimitedError,
     ServerError,
 )
-from pytest import raises
-from requests import Response
+from vonage_http_client.http_client import HttpClient
 
-from http_client.http_client import HttpClient
-from testing_utils import build_response
+from testutils import build_response
 
 path = abspath(__file__)