Official Uber Rides API Python SDK
Python SDK (beta) to support the Uber Rides API.
To use the Uber Rides Python SDK:
$ pip install uber_rides
Head over to pip-installer for instructions on installing pip.
To run from source, you can download the source code for uber-rides, and then run:
$ python setup.py install
We recommend using virtualenv when setting up your project environment. You may need to run the above commands with sudo if you’re not using it.
If you just need read-only access to Uber API resources, like getting a location’s available products, create a Session with the server token you received after registering your app.
from uber_rides.session import Session session = Session(server_token=YOUR_SERVER_TOKEN)
Use this Session to create an UberRidesClient and fetch API resources:
from uber_rides.client import UberRidesClient client = UberRidesClient(session) response = client.get_products(37.77, -122.41) products = response.json.get('products')
Navigate to the example folder to access the python scripts examples. Before you can run an example, you must edit the example/config.yaml file and add your app credentials.
To get an UberRidesClient through the Authorization Code flow, run:
$ python example/authorize_user.py
The example above stores user credentials in example/oauth2_session_store.yaml. To create an UberRidesClient with these credentials and go through a surge ride request run:
$ python example/request_ride.py
response = client.get_products(37.77, -122.41) products = response.json.get('products') product_id = products.get('product_id')
response = client.get_price_estimates( start_latitude=37.770, start_longitude=-122.411, end_latitude=37.791, end_longitude=-122.405, seat_count=2 ) estimate = response.json.get('prices')
response = client.get_user_profile() profile = response.json first_name = profile.get('first_name') last_name = profile.get('last_name') email = profile.get('email')
response = client.get_user_activity() history = response.json
# Get products for location response = client.get_products(37.77, -122.41) products = response.json.get('products') product_id = products.get('product_id') # Get upfront fare for product with start/end location estimate = client.estimate_ride( product_id=product_id, start_latitude=37.77, start_longitude=-122.41, end_latitude=37.79, end_longitude=-122.41, seat_count=2 ) fare = estimate.json.get('fare') # Request ride with upfront fare for product with start/end location response = client.request_ride( product_id=product_id, start_latitude=37.77, start_longitude=-122.41, end_latitude=37.79, end_longitude=-122.41, seat_count=2, fare_id=fare['fare_id'] ) request = response.json request_id = request.get('request_id') # Request ride details from request_id response = client.get_ride_details(request_id) ride = response.json # Cancel a ride response = client.cancel_ride(request_id) ride = response.json
This makes a real-world request and send an Uber driver to the specified start location.
To develop and test against request endpoints in a sandbox environment, make sure to instantiate your UberRidesClient with
client = UberRidesClient(session, sandbox_mode=True)
The default for sandbox_mode is set to False. See our documentation to read more about using the Sandbox Environment.
If you are requesting sandbox rides, you will need to step through the different states of a ride.
response = client.update_sandbox_ride(ride_id, 'accepted') response = client.update_sandbox_ride(ride_id, 'in_progress')
If the update is successful, response.status_code will be 204.
The update_sandbox_ride method is not valid in normal mode, where the ride status will change automatically.
Uber developers actively monitor the Uber Tag on StackOverflow. If you need help installing or using the library, you can ask a question there. Make sure to tag your question with uber-api and python!
For full documentation about our API, visit our Developer Site.
See the Getting Started Tutorial.
We love contributions. If you’ve found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo. Write a test to show your bug was fixed or the feature works as expected.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|File Name & Checksum SHA256 Checksum Help||Version||File Type||Upload Date|
|uber_rides-0.4.1-py2.py3-none-any.whl (51.6 kB) Copy SHA256 Checksum SHA256||2.7||Wheel||Feb 8, 2017|
|uber_rides-0.4.1.tar.gz (89.6 kB) Copy SHA256 Checksum SHA256||–||Source||Feb 8, 2017|