Feature/improved help (#81)

* adding list bookings module

* adding `list_requests` parser

* adding `show_inbox` parser

* adding a `logout` parser

* adding `prog` arg to parsers

* improving test coverage

* improving docstrings

* making `help_<command>` methods `@staticmethod`

* fixing potential arg errors

* making help method static

mini_project_1/book_member.py

@@ -27,11 +27,13 @@
 
 def get_book_member_parser() -> ShellArgumentParser:
     parser = ShellArgumentParser(
+        prog="book_member",
         add_help=False,
         description="Book a member on a ride")
 
     parser.add_argument("email",
-                        help="Email of the member who will be booked on the ride")
+                        help="Email of the member who will be booked on "
+                             "the ride")
     parser.add_argument("seats", type=greater_than_zero_number,
                         help="The number of seats booked")
     parser.add_argument("price", type=price,

mini_project_1/cancel_booking.py

@@ -15,6 +15,7 @@ def get_cancel_booking_parser() -> ShellArgumentParser:
     """Get a :class:`ShellArgumentParser` for use in parsing the arguments
     for a ``cancel_booking`` command"""
     parser = ShellArgumentParser(
+        prog="cancel_booking",
         add_help=False,
         description="Cancel a booking")
 

mini_project_1/delete_request.py

@@ -11,6 +11,7 @@
 
 def get_delete_request_parser() -> ShellArgumentParser:
     parser = ShellArgumentParser(
+        prog="delete_request",
         add_help=False,
         description="Delete a ride request by rid")
 

mini_project_1/list_bookings.py

@@ -0,0 +1,19 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+"""List bookings
+
+The member should be able to list all bookings on rides s/he offers.
+"""
+
+from mini_project_1.common import ShellArgumentParser
+
+
+def get_list_bookings_parser() -> ShellArgumentParser:
+    parser = ShellArgumentParser(
+        prog="list_bookings",
+        add_help=False,
+        description="List all the bookings that you offer")
+
+    return parser
+

mini_project_1/list_requests.py

@@ -0,0 +1,19 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+"""List requests
+
+The member should be able to see all his/her ride requests.
+"""
+
+from mini_project_1.common import ShellArgumentParser
+
+
+def get_list_ride_requests_parser() -> ShellArgumentParser:
+    parser = ShellArgumentParser(
+        prog="list_requests",
+        add_help=False,
+        description="List all the ride requests that you offer")
+
+    return parser
+

mini_project_1/logout.py

@@ -0,0 +1,15 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+"""Logout functionality"""
+
+from mini_project_1.common import ShellArgumentParser
+
+
+def get_logout_parser() -> ShellArgumentParser:
+    parser = ShellArgumentParser(
+        prog="logout",
+        add_help=False,
+        description="Logout to the mini-project-1 database")
+
+    return parser

mini_project_1/offer_ride.py

@@ -20,6 +20,7 @@
 
 def get_offer_ride_parser() -> ShellArgumentParser:
     parser = ShellArgumentParser(
+        prog="offer_ride",
         add_help=False,
         description="Offer a ride")
 

mini_project_1/post_request.py

@@ -48,6 +48,7 @@ def get_post_request_parser() -> ShellArgumentParser:
     """Get a :class:`ShellArgumentParser` for use in parsing the arguments
     for a ``post_ride_request`` command"""
     parser = ShellArgumentParser(
+        prog="post_request",
         add_help=False,
         description="Post a ride request")
 

mini_project_1/search_requests.py

@@ -16,6 +16,7 @@
 
 def get_search_requests_lcode_parser() -> ShellArgumentParser:
     parser = ShellArgumentParser(
+        prog="search_requests_lcode",
         add_help=False,
         description="Search ride requests by location code")
 
@@ -26,6 +27,7 @@ def get_search_requests_lcode_parser() -> ShellArgumentParser:
 
 def get_search_requests_city_parser() -> ShellArgumentParser:
     parser = ShellArgumentParser(
+        prog="search_requests_city",
         add_help=False,
         description="Search ride requests by city name")
 

mini_project_1/search_rides.py

@@ -20,6 +20,7 @@
 
 def get_search_for_ride_parser() -> ShellArgumentParser:
     parser = ShellArgumentParser(
+        prog="search_rides",
         add_help=False,
         description="Search for a ride and if one is selected sent a message "
                     "of intent to join")

mini_project_1/select_request.py

@@ -8,6 +8,7 @@
 
 def get_select_request_parser() -> ShellArgumentParser:
     parser = ShellArgumentParser(
+        prog="select_request",
         add_help=False,
         description="Select a ride request and perform actions with it"
     )