Mini-Project-1 Shell Command Line Use¶
Below is usage documentation on using the mini-project-1 shell and the various commands associated with it.
Note
For an in-depth look at the mini-project-1 shell please look at the
shell.MiniProjectShell directly.
book_member¶
Book a member on a ride
usage: book_member email seats price pickup dropoff
Positional Arguments¶
| Email of the member who will be booked on the ride | |
| seats | The number of seats booked |
| price | The cost per seat for the ride |
| pickup | Keyword for the pickup location of the ride |
| dropoff | Keyword for the dropoff location of the ride |
cancel_booking¶
Cancel a booking
usage: cancel_booking bno
Positional Arguments¶
| bno | The booking identification number |
delete_request¶
Delete a ride request by rid
usage: delete_request rid
Positional Arguments¶
| rid | The ID of the ride request to delete |
List all the bookings that you offer
usage: list_bookings
offer_ride¶
Offer a ride
usage: offer_ride [--cno [CNO]] [--enroute ENROUTE [ENROUTE ...]]
date seats price luggage src dst
Positional Arguments¶
| date | Date the ride should start on (eg: 1975-05-21T22:00:00) |
| seats | The number of seats offered |
| price | The amount you want per seat for the ride |
| luggage | Description of car luggage |
| src | Keyword for the start location of the ride |
| dst | Keyword for the end location of the ride |
Named Arguments¶
| --cno | Your car number to use |
| --enroute | Enroute locations to go to Default: set() |
post_request¶
Post a ride request
usage: post_request date pickup dropoff price
Positional Arguments¶
| date | Date the ride should start on (eg: 1975-05-21T22:00:00) |
| pickup | The location code for the pickup location of the ride |
| dropoff | The location code for the dropoff location of the ride |
| price | The maximum amount you are willing to pay per seat for the ride |
search_requests_lcode¶
Search ride requests by location code
usage: search_requests_lcode lcode
Positional Arguments¶
| lcode | The location code to search by |
search_requests_city¶
Search ride requests by city name
usage: search_requests_city city
Positional Arguments¶
| city | The name of the city to search by |
search_rides¶
Search for a ride and if one is selected sent a message of intent to join
usage: search_rides term1 [term2] [term3]
Positional Arguments¶
| term1 | Location search term to use to look rides |
| term2 | Location search term to use to look rides |
| term3 | Location search term to use to look rides |