bookalimo 1.0.1__tar.gz → 1.0.2__tar.gz

bookalimo-1.0.2/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.4
+Name: bookalimo
+Version: 1.0.2
+Summary: Python wrapper for the Book-A-Limo API
+Author-email: Jonathan Oren <jonathan@bookalimo.com>
+Maintainer-email: Jonathan Oren <jonathan@bookalimo.com>
+License: MIT
+Project-URL: Homepage, https://github.com/asparagusbeef/bookalimo-python
+Project-URL: Documentation, https://asparagusbeef.github.io/bookalimo-python
+Project-URL: Repository, https://github.com/asparagusbeef/bookalimo-python
+Project-URL: Issues, https://github.com/asparagusbeef/bookalimo-python/issues
+Project-URL: Changelog, https://github.com/asparagusbeef/bookalimo-python/blob/main/CHANGELOG.md
+Keywords: bookalimo,api,transportation,booking
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pydantic>=2.11.0
+Requires-Dist: pycountry>=22.0.0
+Requires-Dist: us>=3.0.0
+Requires-Dist: airportsdata>=20230101
+Provides-Extra: places
+Requires-Dist: google-maps-places>=0.1.0; extra == "places"
+Requires-Dist: google-api-core>=2.0.0; extra == "places"
+Requires-Dist: numpy>=2.0.0; extra == "places"
+Requires-Dist: rapidfuzz>=3.0.0; extra == "places"
+Requires-Dist: typing-extensions>=4.15.0; python_version < "3.11" and extra == "places"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
+Requires-Dist: httpx[mock]>=0.25.0; extra == "dev"
+Requires-Dist: respx>=0.20.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.5.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Requires-Dist: python-dotenv>=1.0.0; extra == "dev"
+Requires-Dist: types-protobuf>=6.0.0; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: pytest-mock>=3.10.0; extra == "test"
+Requires-Dist: httpx[mock]>=0.25.0; extra == "test"
+Requires-Dist: respx>=0.20.0; extra == "test"
+Dynamic: license-file
+
+# Bookalimo Python SDK
+
+[![codecov](https://codecov.io/gh/asparagusbeef/bookalimo-python/branch/main/graph/badge.svg?token=H588J8Q1M8)](https://codecov.io/gh/asparagusbeef/bookalimo-python)
+[![Docs](https://img.shields.io/github/deployments/asparagusbeef/bookalimo-python/github-pages?label=docs&logo=github)](https://asparagusbeef.github.io/bookalimo-python)
+[![PyPI version](https://badge.fury.io/py/bookalimo.svg)](https://badge.fury.io/py/bookalimo)
+[![Python Support](https://img.shields.io/pypi/pyversions/bookalimo.svg)](https://pypi.org/project/bookalimo/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+Python client library for the Book-A-Limo transportation booking API with async/sync support, type safety, and Google Places integration.
+
+## Design philosophy: IDE-first DX
+
+The library is **comprehensively typed** and **richly documented** via docstrings. Most users can rely on IDE hints, docstrings, and autocomplete without reading the docs.
+
+## Features
+
+- **Async & Sync Support** – `AsyncBookalimo` and `Bookalimo` clients
+- **Type Safety** – Full Pydantic models with validation
+- **Google Places Integration** – Location search and geocoding
+- **Automatic Retry** – Built-in exponential backoff
+- **Resource Management** – Context managers for proper cleanup
+
+## Installation
+
+```bash
+pip install bookalimo
+
+# With Google Places integration
+pip install bookalimo[places]
+```
+
+## Quick Example
+
+```python
+import asyncio
+from bookalimo import (
+    AsyncBookalimo,
+)
+from bookalimo.transport.auth import (
+    Credentials,
+)
+from bookalimo.schemas import (
+    RateType,
+    Location,
+    LocationType,
+    Address,
+    City,
+    Airport,
+    PriceRequest,
+    BookRequest,
+)
+
+
+async def book_ride():
+    credentials = Credentials.create(
+        "your_id",
+        "your_password",
+        is_customer=False,
+    )
+
+    pickup = Location(
+        type=LocationType.ADDRESS,
+        address=Address(
+            place_name="Empire State Building",
+            city=City(
+                city_name="New York",
+                country_code="US",
+                state_code="NY",
+            ),
+        ),
+    )
+    dropoff = Location(
+        type=LocationType.AIRPORT,
+        airport=Airport(iata_code="JFK"),
+    )
+
+    async with AsyncBookalimo(credentials=credentials) as client:
+        # Get pricing
+        quote = await client.pricing.quote(
+            PriceRequest(
+                rate_type=RateType.P2P,
+                date_time="12/25/2024 03:00 PM",
+                pickup=pickup,
+                dropoff=dropoff,
+                passengers=2,
+                luggage=2,
+            )
+        )
+
+        # Book reservation
+        booking = await client.reservations.book(
+            BookRequest(
+                token=quote.token,
+                method="charge",
+            )
+        )
+        return booking.reservation_id
+
+
+confirmation = asyncio.run(book_ride())
+```
+
+## Sync Usage
+
+```python
+from bookalimo import (
+    Bookalimo,
+)
+
+with Bookalimo(credentials=credentials) as client:
+    quote = client.pricing.quote(PriceRequest(...))
+    booking = client.reservations.book(
+        BookRequest(
+            token=quote.token,
+            method="charge",
+        )
+    )
+```
+
+## Google Places Integration
+
+```python
+async with AsyncBookalimo(
+    credentials=credentials,
+    google_places_api_key="your-google-places-key",
+) as client:
+    # Search locations
+    results = await client.places.search("Hilton Miami Beach")
+
+    # Resolve airports near landmarks
+    airports = await client.places.resolve_airport(query="eiffel tower")
+    top_airport = airports[0]  # Closest airport with confidence scoring
+
+    # Use in booking flow
+    quote = await client.pricing.quote(...)
+```
+
+## Error Handling
+
+```python
+from bookalimo.exceptions import (
+    BookalimoHTTPError,
+    BookalimoValidationError,
+)
+
+try:
+    booking = await client.reservations.book(...)
+except BookalimoValidationError as e:
+    print(f"Invalid input: {e.message}")
+except BookalimoHTTPError as e:
+    if e.status_code == 401:
+        print("Authentication failed")
+```
+
+## Environment
+
+```bash
+export GOOGLE_PLACES_API_KEY="your_google_places_key"
+export BOOKALIMO_LOG_LEVEL="DEBUG"
+```
+
+## Documentation
+
+**📖 Complete Documentation:** [https://asparagusbeef.github.io/bookalimo-python](https://asparagusbeef.github.io/bookalimo-python)
+
+## Requirements
+
+* Python 3.9+
+* Book-A-Limo API credentials
+* Dependencies: httpx, pydantic, pycountry, us, airportsdata, typing-extensions for Python 3.9-3.10
+  - Optional: google-maps-places, google-api-core, numpy, rapidfuzz
+
+## Support & Resources
+
+* GitHub: [https://github.com/asparagusbeef/bookalimo-python](https://github.com/asparagusbeef/bookalimo-python)
+* PyPI: [https://pypi.org/project/bookalimo/](https://pypi.org/project/bookalimo/)
+* Issues: [https://github.com/asparagusbeef/bookalimo-python/issues](https://github.com/asparagusbeef/bookalimo-python/issues)
+* Changelog: [CHANGELOG.md](./CHANGELOG.md)
+
+## License
+
+MIT License — see [LICENSE](LICENSE) for details.

bookalimo-1.0.2/README.md

@@ -0,0 +1,183 @@
+# Bookalimo Python SDK
+
+[![codecov](https://codecov.io/gh/asparagusbeef/bookalimo-python/branch/main/graph/badge.svg?token=H588J8Q1M8)](https://codecov.io/gh/asparagusbeef/bookalimo-python)
+[![Docs](https://img.shields.io/github/deployments/asparagusbeef/bookalimo-python/github-pages?label=docs&logo=github)](https://asparagusbeef.github.io/bookalimo-python)
+[![PyPI version](https://badge.fury.io/py/bookalimo.svg)](https://badge.fury.io/py/bookalimo)
+[![Python Support](https://img.shields.io/pypi/pyversions/bookalimo.svg)](https://pypi.org/project/bookalimo/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+Python client library for the Book-A-Limo transportation booking API with async/sync support, type safety, and Google Places integration.
+
+## Design philosophy: IDE-first DX
+
+The library is **comprehensively typed** and **richly documented** via docstrings. Most users can rely on IDE hints, docstrings, and autocomplete without reading the docs.
+
+## Features
+
+- **Async & Sync Support** – `AsyncBookalimo` and `Bookalimo` clients
+- **Type Safety** – Full Pydantic models with validation
+- **Google Places Integration** – Location search and geocoding
+- **Automatic Retry** – Built-in exponential backoff
+- **Resource Management** – Context managers for proper cleanup
+
+## Installation
+
+```bash
+pip install bookalimo
+
+# With Google Places integration
+pip install bookalimo[places]
+```
+
+## Quick Example
+
+```python
+import asyncio
+from bookalimo import (
+    AsyncBookalimo,
+)
+from bookalimo.transport.auth import (
+    Credentials,
+)
+from bookalimo.schemas import (
+    RateType,
+    Location,
+    LocationType,
+    Address,
+    City,
+    Airport,
+    PriceRequest,
+    BookRequest,
+)
+
+
+async def book_ride():
+    credentials = Credentials.create(
+        "your_id",
+        "your_password",
+        is_customer=False,
+    )
+
+    pickup = Location(
+        type=LocationType.ADDRESS,
+        address=Address(
+            place_name="Empire State Building",
+            city=City(
+                city_name="New York",
+                country_code="US",
+                state_code="NY",
+            ),
+        ),
+    )
+    dropoff = Location(
+        type=LocationType.AIRPORT,
+        airport=Airport(iata_code="JFK"),
+    )
+
+    async with AsyncBookalimo(credentials=credentials) as client:
+        # Get pricing
+        quote = await client.pricing.quote(
+            PriceRequest(
+                rate_type=RateType.P2P,
+                date_time="12/25/2024 03:00 PM",
+                pickup=pickup,
+                dropoff=dropoff,
+                passengers=2,
+                luggage=2,
+            )
+        )
+
+        # Book reservation
+        booking = await client.reservations.book(
+            BookRequest(
+                token=quote.token,
+                method="charge",
+            )
+        )
+        return booking.reservation_id
+
+
+confirmation = asyncio.run(book_ride())
+```
+
+## Sync Usage
+
+```python
+from bookalimo import (
+    Bookalimo,
+)
+
+with Bookalimo(credentials=credentials) as client:
+    quote = client.pricing.quote(PriceRequest(...))
+    booking = client.reservations.book(
+        BookRequest(
+            token=quote.token,
+            method="charge",
+        )
+    )
+```
+
+## Google Places Integration
+
+```python
+async with AsyncBookalimo(
+    credentials=credentials,
+    google_places_api_key="your-google-places-key",
+) as client:
+    # Search locations
+    results = await client.places.search("Hilton Miami Beach")
+
+    # Resolve airports near landmarks
+    airports = await client.places.resolve_airport(query="eiffel tower")
+    top_airport = airports[0]  # Closest airport with confidence scoring
+
+    # Use in booking flow
+    quote = await client.pricing.quote(...)
+```
+
+## Error Handling
+
+```python
+from bookalimo.exceptions import (
+    BookalimoHTTPError,
+    BookalimoValidationError,
+)
+
+try:
+    booking = await client.reservations.book(...)
+except BookalimoValidationError as e:
+    print(f"Invalid input: {e.message}")
+except BookalimoHTTPError as e:
+    if e.status_code == 401:
+        print("Authentication failed")
+```
+
+## Environment
+
+```bash
+export GOOGLE_PLACES_API_KEY="your_google_places_key"
+export BOOKALIMO_LOG_LEVEL="DEBUG"
+```
+
+## Documentation
+
+**📖 Complete Documentation:** [https://asparagusbeef.github.io/bookalimo-python](https://asparagusbeef.github.io/bookalimo-python)
+
+## Requirements
+
+* Python 3.9+
+* Book-A-Limo API credentials
+* Dependencies: httpx, pydantic, pycountry, us, airportsdata, typing-extensions for Python 3.9-3.10
+  - Optional: google-maps-places, google-api-core, numpy, rapidfuzz
+
+## Support & Resources
+
+* GitHub: [https://github.com/asparagusbeef/bookalimo-python](https://github.com/asparagusbeef/bookalimo-python)
+* PyPI: [https://pypi.org/project/bookalimo/](https://pypi.org/project/bookalimo/)
+* Issues: [https://github.com/asparagusbeef/bookalimo-python/issues](https://github.com/asparagusbeef/bookalimo-python/issues)
+* Changelog: [CHANGELOG.md](./CHANGELOG.md)
+
+## License
+
+MIT License — see [LICENSE](LICENSE) for details.

{bookalimo-1.0.1 → bookalimo-1.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "bookalimo"
-version = "1.0.1"
+version = "1.0.2"
 description = "Python wrapper for the Book-A-Limo API"
 readme = "README.md"
 license = {text = "MIT"}
@@ -43,7 +43,8 @@ places = [
     "google-maps-places>=0.1.0",
     "google-api-core>=2.0.0",
     "numpy>=2.0.0",
-    "rapidfuzz>=3.0.0"
+    "rapidfuzz>=3.0.0",
+    "typing-extensions>=4.15.0; python_version < '3.11'"
 ]
 dev = [
     "pytest>=7.0.0",
@@ -96,7 +97,7 @@ lint.select = [
     "UP", # pyupgrade
 ]
 lint.ignore = [
-    "E501", # line too long, handled by black
+    "E501", # line too long, handled by ruff-format
     "B008", # do not perform function calls in argument defaults
     "C901", # too complex
     "UP045", # until I have time to Optional[] -> X | None everywhere.
@@ -127,7 +128,7 @@ warn_return_any = true
 warn_unreachable = true
 warn_unused_configs = true
 warn_unused_ignores = true
-mypy_path = "stubs"
+mypy_path = "src:stubs"
 disable_error_code = ["prop-decorator"]
 
 [[tool.mypy.overrides]]

{bookalimo-1.0.1 → bookalimo-1.0.2}/src/bookalimo/client.py

@@ -59,7 +59,7 @@ class AsyncBookalimo:
             google_places_api_key="your-google-api-key"
         ) as client:
             # Find locations using Google Places
-            places = await client.places.search_text("Empire State Building")
+            places = await client.places.search("Empire State Building")
 
             # Use in booking
             quote = await client.pricing.quote(
@@ -93,8 +93,7 @@ class AsyncBookalimo:
             transport: Custom transport instance (optional)
             google_places_api_key: Google Places API key for location services (optional)
         """
-
-        transport_credentials = transport.credentials if transport else None
+        transport_credentials = transport._credentials if transport else None
 
         both_provided = all([transport_credentials, credentials])
         both_missing = not any([transport_credentials, credentials])
@@ -113,18 +112,21 @@ class AsyncBookalimo:
                 stacklevel=2,
             )
 
-        # Use whichever exists when we need to build a transport ourselves
         effective_credentials = (
-            credentials if credentials is not None else transport_credentials
+            transport_credentials if transport_credentials is not None else credentials
         )
+
         if transport:
-            transport.credentials = effective_credentials
-        self._transport = transport or AsyncTransport(
-            base_url=base_url,
-            timeouts=timeouts,
-            user_agent=user_agent,
-            credentials=effective_credentials,
-        )
+            if transport_credentials is None and credentials is not None:
+                transport.credentials = credentials
+            self._transport = transport
+        else:
+            self._transport = AsyncTransport(
+                base_url=base_url,
+                timeouts=timeouts,
+                user_agent=user_agent,
+                credentials=effective_credentials,
+            )
 
         # Initialize service instances
         self.reservations = AsyncReservationsService(self._transport)
@@ -149,7 +151,7 @@ class AsyncBookalimo:
             Auth priority is as follows:
               - provided api key in constructor
               - GOOGLE_PLACES_API_KEY environment variable
-              - Google ADC - Except for Geocoding API.
+              - Google ADC - Not yet implemented.
         """
         if not _GOOGLE_PLACES_AVAILABLE:
             raise ImportError(
@@ -207,7 +209,7 @@ class Bookalimo:
             google_places_api_key="your-google-api-key"
         ) as client:
             # Find locations using Google Places
-            places = client.places.search_text("Empire State Building")
+            places = client.places.search("Empire State Building")
 
             # Use in booking
             quote = client.pricing.quote(
@@ -241,20 +243,41 @@ class Bookalimo:
             transport: Custom transport instance (optional)
             google_places_api_key: Google Places API key for location services (optional)
         """
-        if transport and transport.credentials is not None and credentials is not None:
+        transport_credentials = transport.credentials if transport else None
+
+        both_provided = all([transport_credentials, credentials])
+        both_missing = not any([transport_credentials, credentials])
+
+        if both_provided:
             warnings.warn(
                 "Credentials provided in both transport and constructor. "
                 "The transport credentials will be used.",
-                UserWarning,
+                DuplicateCredentialsWarning,
                 stacklevel=2,
             )
-        self._transport = transport or SyncTransport(
-            base_url=base_url,
-            timeouts=timeouts,
-            user_agent=user_agent,
-            credentials=credentials,
+        elif both_missing:
+            warnings.warn(
+                "No credentials provided in transport or constructor; proceeding unauthenticated.",
+                MissingCredentialsWarning,
+                stacklevel=2,
+            )
+
+        effective_credentials = (
+            transport_credentials if transport_credentials is not None else credentials
         )
 
+        if transport:
+            if transport_credentials is None and credentials is not None:
+                transport.credentials = credentials
+            self._transport = transport
+        else:
+            self._transport = SyncTransport(
+                base_url=base_url,
+                timeouts=timeouts,
+                user_agent=user_agent,
+                credentials=effective_credentials,
+            )
+
         # Initialize service instances
         self.reservations = ReservationsService(self._transport)
         self.pricing = PricingService(self._transport)
@@ -278,7 +301,7 @@ class Bookalimo:
             Auth priority is as follows:
               - provided api key in constructor
               - GOOGLE_PLACES_API_KEY environment variable
-              - Google ADC - Except for Geocoding API.
+              - Google ADC - Not yet implemented.
         """
         if not _GOOGLE_PLACES_AVAILABLE:
             raise ImportError(