Metadata-Version: 1.0
Name: martapy
Version: 1.1
Summary: Wrapper for MARTA realtime rail/bus APIs
Home-page: https://github.com/arcward/fbparser
Author: Edward Wells
Author-email: git@edward.sh
License: MIT
Description: =======
        MARTApy
        =======
        Python wrapper for MARTA realtime rail and bus APIs:
        http://www.itsmarta.com/app-developer-resources.aspx
        
        ============
        Installation
        ============
        To install via *pip*, just:
        
        .. code-block:: bash
        
            $ pip install martapy
        
        Or, locally from the same directory as ``setup.py``:
        
        .. code-block:: bash
        
            $ python setup.py install
        
        ====
        Rail
        ====
        To get a list of train arrivals:
        
        .. code-block:: python
        
            from martapy import RailClient
        
            rail_client = RailClient(api_key="your_api_key")
            arrivals = rail_client.arrivals()
        
        This returns an instance of ``martapy.rail.Arrivals(list)`` which
        has a few handy methods to filter results further.
        
        For example, to print the destination and waiting time for upcoming
        arrivals at *Peachtree Center Station*:
        
        .. code-block:: python
        
            from martapy import RailClient
        
            rail_client = RailClient(api_key="your_api_key")
            peachtree_station = rail_client.arrivals().by_station('peachtree')
        
            for arrival in peachtree_station:
                print("To: {}, When: {}".format(arrival.destination, arrival.waiting_time))
        
        With output that would look something like::
            To: Airport, When: Arriving
            To: Lindbergh, When: 16 min
            To: Doraville, When: 19 min
        
        Filters
        -------
        To narrow results, ``martapy.rail.Arrivals(list)`` has
        a number of properties/methods:
        
        - Arrivals by **line**:
          ``red_line``
          ``blue_line``
          ``green_line``
          ``gold_line``
        - Arrivals by **direction**:
          ``northbound``
          ``eastbound``
          ``westbound``
          ``southbound``
        - Arrivals by **waiting time**:
          ``boarding``
          ``arriving``
          ``arrived``
        - Arrivals grouped by **station name**:
          ``Arrivals.stations``
        - Arrivals grouped by **train ID**:
          ``Arrivals.trains``
        - Arrivals associated with a **specific station**:
          ``Arrivals.by_station('station name')``
        
        These can be chained as well for more specific results. For example, to
        get all arrivals for the red line which are heading southbound:
        
        .. code-block:: python
        
            from martapy.rail import RailClient
        
            rail_client = RailClient(api_key="your_api_key")
            arrivals = rail_client.arrivals().red_line.southbound
        
        Other properties
        ----------------
        Each ``Arrivals`` instance returned is just a list of
        ``martapy.rail.Arrival`` objects, with properties similar to the filters
        above (*station, direction, event\_time, line...*). To get the original
        JSON string back, use ``Arrival.json``.
        
        ====
        Bus
        ====
        To get a list of active buses:
        
        .. code-block:: python
        
            from martapy import BusClient
        
            bus_client = BusClient()
            buses = bus_client.buses()
        
        To get active buses for a particular route number, use
        ``BusClient.buses(route=111)`` (or any other route number)
        
        To filter this list down further, use ``filter()`` on the returned ``Buses``
        list. For example, to return only *Westbound* buses:
        
        .. code-block:: python
        
            from martapy import BusClient
        
            bus_client = BusClient()
            buses = bus_client.buses().filter(direction='Westbound')
Keywords: MARTA API rail train Atlanta Georgia GA ATL itsmarta
Platform: UNKNOWN
