Skip to content

Latest commit

 

History

History
115 lines (83 loc) · 2.53 KB

README.md

File metadata and controls

115 lines (83 loc) · 2.53 KB
Raw

Omnivore Python library

Installation

pip install git+git://github.com/chillbear/omnivore.git@master

To install from source, run

git clone https://github.com/chillbear/omnivore.git
cd omnivore
python setup.py install

Documentation

Please see the Omnivore API Documentation for the most up-to-date API documentation.

Usage

This library has only been tested using Python 2.7.10.

Getting and interacting with locations:

import omnivore

omnivore.api_key = 'xxx'

locations = omnivore.Location.all()
location = locations[0]

# print location.discounts
# print location.employees
# print location.order_types
# print location.revenue_centers
# print location.tables
# print location.tender_types
# print location.tickets

Properties are cached on each model instance. To refresh, do location = Location.get(location.id). (TODO: allow properties to be refreshed manually)

Objects embedded in API responses are added as properties on each model instance. To refresh, do locations.refresh().

Interacting with tickets:

employee_id = 'xxx'
order_type_id = 'xxx'
revenue_center_id = 'xxx'
table_id = 'xxx'
guest_count = 1
name = 'Test Ticket'
auto_send = True

ticket = location.open_ticket(
    employee_id,
    order_type_id,
    revenue_center_id,
    table_id,
    guest_count,
    name,
    auto_send
)
print ticket
# ticket.void()

tip = ticket.totals['total'] * .2
print ticket.pay('3rd_party', ticket.totals['due'], tip, tender_type='xxx, payment_source='doordash')
# {
#     "amount_paid": 100,
#     "accepted": True,
#     "ticket_closed": True,
#     "balance_remaining": 0,
#     "type": "3rd_party"
# }

Interacting with menus:

menu = location.menu

categories = menu.categories
items = menu.items
modifiers = menu.modifiers

# TODO: display modifiers and modifier groups

Development

We use virtualenv. Install with [sudo] pip install virtualenv, initialize with virtualenv venv, and activate with source venv/bin/activate.

Install the development requirements with pip install -r requirements/dev.txt

Testing

To run the test suite, run py.test from the project root.

Linting

We enforce linting on the code with flake8. Run with flake8 omnivore from the project root.

TODOs

  • create method for Discount
  • allow refresh of cached properties
  • remove has_embedded_objects for things like nested ticket resources where they will never show up as an embedded object
  • allow addition of multiple TicketItems
  • tests