bookalimo 0.1.5__py3-none-any.whl → 1.0.1__py3-none-any.whl

bookalimo-1.0.1.dist-info/METADATA

@@ -0,0 +1,370 @@
+Metadata-Version: 2.4
+Name: bookalimo
+Version: 1.0.1
+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"
+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)
+
+A modern, fully-typed Python SDK for the Book-A-Limo transportation booking API with async/sync support, type safety, Google Places integration, and ergonomic resource management via context managers.
+
+## Important notes
+
+- **Docs are in preview**: Many pages were AI-generated from the codebase and haven’t had a full manual review yet. In case of conflict, the code and docstrings are the source of truth. Please [report issues](https://github.com/asparagusbeef/bookalimo-python/issues) you find.
+- **Terms & credentials**: Use of Book-A-Limo API and Google APIs are subject to their respective Terms of Service.
+
+## 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** – Choose the right client for your use case
+- **Type Safety** – Full Pydantic models with validation
+- **Google Places Integration** – Autocomplete, search, details, and geocoding
+- **Automatic Retry** – Built-in exponential backoff for reliability
+- **Comprehensive Error Handling** – Detailed exceptions with context
+- **Resource Management** – Context managers for proper cleanup
+
+## Installation
+
+```bash
+pip install bookalimo
+
+# With Google Places integration
+pip install bookalimo[places]
+```
+
+## Core API
+
+### Clients
+
+* `AsyncBookalimo` – Async client for high-concurrency applications
+* `Bookalimo` – Sync client for simple scripts and legacy code
+
+### Services
+
+* `client.pricing` – Get quotes and update booking details
+* `client.reservations` – Book, list, modify, and cancel reservations
+* `client.places` – Google Places search and geocoding (optional)
+
+### Authentication
+
+SHA256-based credential system with automatic password hashing:
+
+```python
+from bookalimo.transport.auth import Credentials
+
+# Agency account
+agency = Credentials.create("AGENCY123", "password", is_customer=False)
+
+# Customer account
+customer = Credentials.create("user@email.com", "password", is_customer=True)
+```
+
+### Booking Flow
+
+1. **Get Pricing** – `client.pricing.quote()` returns session token + vehicle options
+2. **Update Details** – `client.pricing.update_details()` finalize booking details
+3. **Book Reservation** – `client.reservations.book()` confirms with payment
+
+## Quick Examples
+
+### Async example
+
+```python
+import asyncio
+from bookalimo import AsyncBookalimo
+from bookalimo.transport.auth import Credentials
+from bookalimo.schemas.booking import (
+    RateType,
+    Location,
+    LocationType,
+    Address,
+    City,
+    Airport,
+)
+
+
+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:
+        # 1) Get pricing
+        quote = await client.pricing.quote(
+            rate_type=RateType.P2P,
+            date_time="12/25/2024 03:00 PM",
+            pickup=pickup,
+            dropoff=dropoff,
+            passengers=2,
+            luggage=2,
+        )
+
+        # 2) Book reservation
+        booking = await client.reservations.book(
+            token=quote.token, method="charge"  # or credit_card=CreditCard(...)
+        )
+        return booking.reservation_id
+
+
+confirmation = asyncio.run(book_ride())
+```
+
+### Sync example
+
+```python
+from bookalimo import Bookalimo
+from bookalimo.transport.auth import Credentials
+
+credentials = Credentials.create("your_id", "your_password", is_customer=False)
+
+with Bookalimo(credentials=credentials) as client:
+    quote = client.pricing.quote(...)
+    booking = client.reservations.book(token=quote.token, method="charge")
+```
+
+## Rate Types & Options
+
+```python
+from bookalimo.schemas.booking import RateType
+
+# Point-to-point transfer
+quote = await client.pricing.quote(
+    rate_type=RateType.P2P,
+    pickup=pickup_location,
+    dropoff=dropoff_location,
+    # ...
+)
+
+# Hourly service (minimum 2 hours)
+quote = await client.pricing.quote(
+    rate_type=RateType.HOURLY,
+    hours=4,
+    pickup=pickup_location,
+    dropoff=pickup_location,  # Same for hourly
+    # ...
+)
+
+# Daily service
+quote = await client.pricing.quote(
+    rate_type=RateType.DAILY,
+    pickup=hotel_location,
+    dropoff=hotel_location,
+    # ...
+)
+```
+
+## Location Types
+
+```python
+from bookalimo.schemas.booking import Location, LocationType, Address, Airport, City
+
+# Street address
+address_location = Location(
+    type=LocationType.ADDRESS,
+    address=Address(
+        place_name="Empire State Building",
+        street_name="350 5th Ave",
+        city=City(city_name="New York", country_code="US", state_code="NY"),
+    ),
+)
+
+# Airport with flight details
+airport_location = Location(
+    type=LocationType.AIRPORT,
+    airport=Airport(iata_code="JFK", flight_number="UA123", terminal="4"),
+)
+```
+
+## Google Places Integration (Recommended flow)
+
+```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")
+
+    # OR
+    # autocomplete = await client.places.autocomplete(input="Hilton Miami Beach")
+    # top_result = autocomplete.suggestions[0].place_prediction.place
+    # top_result_place_id = top_result.id
+
+    # OR
+    # resolve_airport = await client.places.resolve_airport(query="Hilton Miami Beach")
+    # top_result = resolve_airport[0]
+    # iata_code = top_result.iata_code
+
+    # Get the top result
+    top_result = results[0]
+
+    # Get the top result geocode
+
+    # By place_id
+    top_result_place_id = top_result.google_place.id
+    top_result_geocode = await client.places.geocode(place_id=top_result_place_id)
+
+    # By lat-lng
+    top_result_geocode = await client.places.geocode(
+        lat=top_result.lat, lng=top_result.lng
+    )
+
+    # Convert to booking location
+    location = Location(
+        type=LocationType.ADDRESS,
+        address=Address(
+            google_geocode=top_result_geocode, place_name=top_result.formatted_address
+        ),
+    )
+```
+
+*(You can also search independent pickup/dropoff locations and feed them into the booking flow.)*
+
+## Reservation Management
+
+```python
+# List reservations
+reservations = await client.reservations.list(is_archive=False)
+
+# Get details
+details = await client.reservations.get("ABC123")
+
+# Modify reservation
+edit_result = await client.reservations.edit(
+    confirmation="ABC123", passengers=3, pickup_date="12/26/2024"
+)
+
+# Cancel reservation
+cancel_result = await client.reservations.edit(confirmation="ABC123", is_cancel=True)
+```
+
+## Error Handling
+
+```python
+from bookalimo.exceptions import (
+    BookalimoError,  # base SDK error
+    BookalimoHTTPError,  # HTTP/transport errors
+    BookalimoValidationError,  # input/schema validation errors
+)
+
+try:
+    booking = await client.reservations.book(...)
+except BookalimoValidationError as e:
+    print(f"Invalid input: {e.message}")
+    for error in e.errors():
+        print(f"  {error['loc']}: {error['msg']}")
+except BookalimoHTTPError as e:
+    if e.status_code == 401:
+        print("Authentication failed")
+    elif e.status_code == 400:
+        print(f"Bad request: {e.payload}")
+    else:
+        print(f"API error: {e}")
+except BookalimoError as e:
+    print(f"SDK error: {e}")
+```
+
+## Documentation
+
+**📖 Complete Documentation:** [https://asparagusbeef.github.io/bookalimo-python](https://asparagusbeef.github.io/bookalimo-python)
+
+* Quick Start Guide: [https://asparagusbeef.github.io/bookalimo-python/guide/quickstart/](https://asparagusbeef.github.io/bookalimo-python/guide/quickstart/)
+* API Reference: [https://asparagusbeef.github.io/bookalimo-python/api/](https://asparagusbeef.github.io/bookalimo-python/api/)
+* Examples: [https://asparagusbeef.github.io/bookalimo-python/examples/basic/](https://asparagusbeef.github.io/bookalimo-python/examples/basic/)
+
+## Environment
+
+```bash
+export GOOGLE_PLACES_API_KEY="your_google_places_key"
+export BOOKALIMO_LOG_LEVEL="DEBUG"
+```
+
+## Requirements
+
+* Python 3.9+
+* Book-A-Limo API credentials
+* Dependencies: httpx, pydantic, pycountry, us, airportsdata
+  - 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.dist-info/RECORD

@@ -0,0 +1,38 @@
+bookalimo/__init__.py,sha256=ZFDpnSOo5VQEgusbVAxyF-neFxBptPZANZ-eE1PeIsU,516
+bookalimo/_version.py,sha256=KcHRbOssHorjmpk3Xs1RTqGNSA-sw9tjYqwV19Zfa9c,259
+bookalimo/client.py,sha256=za9o_D1jkaq7atWpM5d3bguWO-rtMYr5StXrBZInsMg,10599
+bookalimo/config.py,sha256=K3HlCj8v34kFM2MaG9evGFomU95hRmenRi1zqe4h8EY,456
+bookalimo/exceptions.py,sha256=pShnuvfMZEP_cChczWhNBLIqa7EOgr4ZNnWj6kphARU,4001
+bookalimo/logging.py,sha256=IF6RQRJvVHgmpXK1qMEGcd0BjU6GxvzbNUBrBKHe-v8,7409
+bookalimo/py.typed,sha256=8PjyZ1aVoQpRVvt71muvuq5qE-jTFZkK-GLHkhdebmc,26
+bookalimo/integrations/__init__.py,sha256=edmQP2Uo8JiNIVaeB4rxM8vagz7BQBhyGEJo70OVS0M,51
+bookalimo/integrations/google_places/__init__.py,sha256=A6jBfGk8ZLYgFiTCGBytBOsyzKVWHI_kjnuZOgdCONc,866
+bookalimo/integrations/google_places/client_async.py,sha256=dSqM5iSG8YEEgb5J1c0vefge8a3wSzY3NZLVDoyJjCA,10981
+bookalimo/integrations/google_places/client_sync.py,sha256=ixnZvfprbWb3sQaUUJdmD4yYlsjg0BWu0lYz7D4uI2M,10801
+bookalimo/integrations/google_places/common.py,sha256=Y5xNTj58eHt1C9sKsZA8MB-1oeGSJQA7G0iA8yX-ywM,7051
+bookalimo/integrations/google_places/proto_adapter.py,sha256=XuVDr-PH9fopykRwNZxQTS_kIBCdwPwcNYBIHCZjmRo,6809
+bookalimo/integrations/google_places/resolve_airport.py,sha256=ZVaT0Q9wDgKFm6tZUu06oy6zCfO58VLcrR7G0FRmDTk,13553
+bookalimo/integrations/google_places/transports.py,sha256=Flb317h5ESj6iOlI89giDu_40v9yK8kNcaiBpJTFn4w,3116
+bookalimo/schemas/__init__.py,sha256=Zrl3MJev7XkVAydd-MderyCe-c-okdxw54PB4Jm499Y,2053
+bookalimo/schemas/base.py,sha256=XEe0Qg7p-LzTmUOJ8CLVDsrry2lKn8sWNin7zwBiw-U,2022
+bookalimo/schemas/booking.py,sha256=ll1usMa6Rfuz63LAWimWlz1UswWn26ZOPBpclN-8yGY,15861
+bookalimo/schemas/places/__init__.py,sha256=8dYqOZYDkGSdzTXXPRbWgUt59gh6vTLffxOIuED694E,1383
+bookalimo/schemas/places/common.py,sha256=NjQKBabFlBytgkqgGABPTlZYkVW035GQRHo3qcTZxTs,10910
+bookalimo/schemas/places/field_mask.py,sha256=tbHEFU2M_9R_lr-u4vIZy8YykBNfhPLfl6N0hmos4II,6816
+bookalimo/schemas/places/google.py,sha256=4eXcesTk19A0ZnVQDlZtNrz6Bl1PBEtEe3ETffpIXZw,29264
+bookalimo/schemas/places/place.py,sha256=5jBqMbPHbRTtXeoFaUtRoIUdzvJeCgMRdeyVt88Axe0,10681
+bookalimo/services/__init__.py,sha256=4wom7MpoeqKy5y99LYFKkl-CAJ7faDN9ZlXUhKVqlAg,303
+bookalimo/services/pricing.py,sha256=MIUVzdnZsmxEEyw9qUdjj71gt3MsckiVLgfXqnPHmNE,5873
+bookalimo/services/reservations.py,sha256=OsbVrVJRggjnifh1eER9PHGqt4PwxZ-Jq1-Dpo4wGKk,7147
+bookalimo/transport/__init__.py,sha256=yD5TDnoqg1xtex41jqJ7Hes849efiYgvW3nkaYr6ZjE,221
+bookalimo/transport/auth.py,sha256=n1XWtU3ddodsDuTuXnDw_pE0qaTe1zrOv7fqHGyOiCg,1249
+bookalimo/transport/base.py,sha256=qeX2HfLaE6gUT5evjOdPiBh8x7z7A84UuWVsgBK3Pyo,1394
+bookalimo/transport/httpx_async.py,sha256=XbXbxcAdUc_CQh_XEYsL0WH6vvECP4fcZWfFCeW5wEU,8100
+bookalimo/transport/httpx_sync.py,sha256=SIlDfiIYKQgAvWsOVeEgxNxlqTKviN_LJX4r8i4Cl5M,7988
+bookalimo/transport/retry.py,sha256=YiJtcdNZUbkrLa1CtKsRtcFO273XJX8naKd8d6ht0LU,2688
+bookalimo/transport/utils.py,sha256=Yoj4P5AzuHbf6pzNPtiiswKab4nHZTCOpIff30-sgbw,1797
+bookalimo-1.0.1.dist-info/licenses/LICENSE,sha256=dW9UYOWGfs9eFlJvwSSkJBDhPRic2mrgFkg6aA0xkMM,1070
+bookalimo-1.0.1.dist-info/METADATA,sha256=xW3rqcCFlQ-IKPfal1T6rgzAg9QmNruKnJPDi-IAlzI,12600
+bookalimo-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bookalimo-1.0.1.dist-info/top_level.txt,sha256=ZgYiDX2GfZCp4pevWn4X2qyEr-Dh7-cq5Y1j2jMhB1s,10
+bookalimo-1.0.1.dist-info/RECORD,,

bookalimo-1.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jonathan Oren
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.