pyTeamUp 0.1.0a1

Python wrapper for TeamUp Calendar's API

# pyTeamUp
Python API wrapper for TeamUp API. In early stages, only has event and calendar objects implemented.

**version**: 0.1.0a1

## Features:
* Pythonic access to TeamUp calendars and events.
* Simple interface for gathering subcalendars and event containers.
* Simple interface for creating and deleting events with `Calendar` object
* `Event` Object features simple interface for updating event properties
* Batch mode for reducing api calls for updating multiple event properties
* If pandas is present, Calendar can return events as Series objects and event collections as DataFrame objects

## Example usage
```python
from pyteamup import Calendar, Event
from datetime import datetime

api_key = 'example api key' # Get your own here: https://teamup.com/api-keys/request
calendar_id = 'example calendar id' # goto www.teamup.com to sign up and get your own calendar

# Instantiate the calendar
calendar = Calendar(calendar_id, api_key)

# Get Subcalendars
subcalendars = calendar.subcalendars
subcal = subcalendars[0]

# Easily Create new events
new_event_dict = {'title': 'New Event Title',
'start_dt': datetime(2018,11,29, 14, 0, 0),
'end_dt': datetime(2018, 11, 29, 14, 0, 0),
'subcalendar_ids': subcal['id'],
'notes': 'This is the description!'}
new_event = Calendar.new_event(**new_event_dict, returnas='event')
print(new_event.event_id)

# Gather Event Collections (returns a list)
event_list = Calendar.get_event_collection()
evnt = event_list.pop()

# Simple change of the title
print(evnt.title)
evnt.title = 'New Title'
print(evnt.title)

# Batch Mode Updates
evnt.enable_batch_mode()
evnt.title = 'New Title 2' # Will display a warning that no changes are made until batch_commit() is called
print(evnt.title) # Will still print the old title
print(evnt.notes)
evnt.notes = 'New Notes!' # Will display a warning that no changes are made until batch_commit() is called

evnt.batch_commit()
print(evnt.title)
print(evnt.notes)

# Prevented from Editing Read-Only Attributes
evnt.event_id = 123 # Will raise an error because attribute is read-only

# Easy Delete and confirm
evnt.delete()
print(evnt.is_deleted) # Will return True

# Get Subcalendars (currently returns list of dictionaries)
```

## todo
* Add support for updating recurring events
* Build Subcalendar object with update support similar to Event object
* Add support for undo (api returns undo id, not sure what this is!)
* Add Tests
* Add more Event endpoints (searching for events, get history, get auxilliary info)
* Add Access Key Endpoints
* Add Color Swatch Lookup (create simple assignments for red, blue, green, etc)
* Make a release available on pip
* Add support for password protected calendars

## Installation
*coming soon*

## Batch Mode
Events objects feature a batch mode for setting multiple values with a single api call, reducing your api usage and reducing the liklihood of TeamUp disabling your api key! Simply call `event.enable_batch_mode()` and begin making changes. When satisfied changes can be commited by calling `event.batch_commit()` which will automatically exit batch mode after, or call `event.disable_batch_mode(clear=True)` to discard changes.

Setting event data without enabling batch mode will cause each change to use an api request.

## Questions
Use issue tracker please :)

## FAQ
none