def __init__(self,
token='',
api_endpoint='https://api.todoist.com',
session=None):
self.api_endpoint = api_endpoint
self.reset_state()
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session(
) # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
def __init__(
self,
token="",
api_endpoint="https://api.todoist.com",
api_version=DEFAULT_API_VERSION,
session=None,
cache="~/.todoist-sync/",
):
self.api_endpoint = api_endpoint
self.api_version = api_version
self.reset_state()
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session(
) # Session instance for requests
# managers
self.biz_invitations = BizInvitationsManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
self.filters = FiltersManager(self)
self.invitations = InvitationsManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.locations = LocationsManager(self)
self.notes = NotesManager(self)
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.reminders = RemindersManager(self)
self.sections = SectionsManager(self)
self.user = UserManager(self)
self.user_settings = UserSettingsManager(self)
self.activity = ActivityManager(self)
self.backups = BackupsManager(self)
self.business_users = BusinessUsersManager(self)
self.completed = CompletedManager(self)
self.emails = EmailsManager(self)
self.quick = QuickManager(self)
self.templates = TemplatesManager(self)
self.uploads = UploadsManager(self)
self.items_archive = ItemsArchiveManagerMaker(self)
self.sections_archive = SectionsArchiveManagerMaker(self)
if cache: # Read and write user state on local disk cache
self.cache = os.path.expanduser(cache)
self._read_cache()
else:
self.cache = None
def __init__(self,
token='',
api_endpoint='https://api.todoist.com',
session=None):
self.api_endpoint = api_endpoint
self.seq_no = 0 # Sequence number since last update
self.seq_no_partial = {} # Sequence number of partial syncs
self.seq_no_global = 0 # Global sequence number since last update
self.seq_no_global_partial = {
} # Global sequence number of partial syncs
self.state = { # Local copy of all of the user's objects
'CollaboratorStates': [],
'Collaborators': [],
'DayOrders': {},
'DayOrdersTimestamp': '',
'Filters': [],
'Items': [],
'Labels': [],
'LiveNotifications': [],
'LiveNotificationsLastRead': -1,
'Locations': [],
'Notes': [],
'ProjectNotes': [],
'Projects': [],
'Reminders': [],
'Settings': {},
'SettingsNotifications': {},
'User': {},
'UserId': -1,
'WebStaticVersion': -1,
}
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session(
) # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
def __init__(self):
self.api = TodoistAPI(get_token())
self.api.sync()
self.api.notes = NotesManager(self.api)
habit_label_ids = [
label['id'] for label in self.api.state['labels']
if label['name'] == 'habit'
]
assert (len(habit_label_ids) == 1)
self.habit_label_id = habit_label_ids[0]
self.habits = self.get_habits()
self.get_datetime()
def __init__(self, token='', api_endpoint='https://api.todoist.com', session=None):
self.api_endpoint = api_endpoint
self.seq_no = 0 # Sequence number since last update
self.seq_no_partial = {} # Sequence number of partial syncs
self.seq_no_global = 0 # Global sequence number since last update
self.seq_no_global_partial = {} # Global sequence number of partial syncs
self.state = { # Local copy of all of the user's objects
'CollaboratorStates': [],
'Collaborators': [],
'DayOrders': {},
'DayOrdersTimestamp': '',
'Filters': [],
'Items': [],
'Labels': [],
'LiveNotifications': [],
'LiveNotificationsLastRead': -1,
'Locations': [],
'Notes': [],
'ProjectNotes': [],
'Projects': [],
'Reminders': [],
'Settings': {},
'SettingsNotifications': {},
'User': {},
'UserId': -1,
'WebStaticVersion': -1,
}
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session() # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
def __init__(self, token="", api_endpoint="https://api.todoist.com"):
self.api_endpoint = api_endpoint
self.seq_no = 0 # Sequence number since last update
self.seq_no_partial = {} # Sequence number of partial syncs
self.seq_no_global = 0 # Global sequence number since last update
self.seq_no_global_partial = {} # Global sequence number of partial syncs
self.state = { # Local copy of all of the user's objects
"CollaboratorStates": [],
"Collaborators": [],
"DayOrders": {},
"DayOrdersTimestamp": "",
"Filters": [],
"Items": [],
"Labels": [],
"LiveNotifications": [],
"LiveNotificationsLastRead": -1,
"Locations": [],
"Notes": [],
"ProjectNotes": [],
"Projects": [],
"Reminders": [],
"Settings": {},
"SettingsNotifications": {},
"User": {},
"UserId": -1,
"WebStaticVersion": -1,
}
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
def __init__(self,
token='',
api_endpoint='https://todoist.com',
session=None,
cache='~/.todoist-sync/'):
self.api_endpoint = api_endpoint
self.reset_state()
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session(
) # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.user_settings = UserSettingsManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
self.completed = CompletedManager(self)
self.uploads = UploadsManager(self)
self.activity = ActivityManager(self)
self.business_users = BusinessUsersManager(self)
self.templates = TemplatesManager(self)
self.backups = BackupsManager(self)
self.quick = QuickManager(self)
self.emails = EmailsManager(self)
if cache: # Read and write user state on local disk cache
self.cache = os.path.expanduser(cache)
self._read_cache()
else:
self.cache = None
def __init__(self, token='', api_endpoint='https://api.todoist.com', session=None):
self.api_endpoint = api_endpoint
self.reset_state()
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session() # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
class TodoistAPI(object):
"""
Implements the API that makes it possible to interact with a Todoist user
account and its data.
"""
_serialize_fields = ('token', 'api_endpoint', 'sync_token', 'state',
'temp_ids')
@classmethod
def deserialize(cls, data):
obj = cls()
for key in cls._serialize_fields:
if key in data:
setattr(obj, key, data[key])
return obj
def __init__(self,
token='',
api_endpoint='https://api.todoist.com',
session=None):
self.api_endpoint = api_endpoint
self.reset_state()
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session(
) # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
def reset_state(self):
self.sync_token = '*'
self.state = { # Local copy of all of the user's objects
'collaborator_states': [],
'collaborators': [],
'day_orders': {},
'day_orders_timestamp': '',
'filters': [],
'items': [],
'labels': [],
'live_notifications': [],
'live_notifications_last_read_id': -1,
'locations': [],
'notes': [],
'project_notes': [],
'projects': [],
'reminders': [],
'settings': {},
'settings_notifications': {},
'user': {},
'web_static_version': -1,
}
def __getitem__(self, key):
return self.state[key]
def serialize(self):
return {key: getattr(self, key) for key in self._serialize_fields}
def get_api_url(self):
return '%s/API/v7/' % self.api_endpoint
def _update_state(self, syncdata):
"""
Updates the local state, with the data returned by the server after a
sync.
"""
# Check sync token first
self.sync_token = syncdata['sync_token']
# It is straightforward to update these type of data, since it is
# enough to just see if they are present in the sync data, and then
# either replace the local values or update them.
if 'collaborators' in syncdata:
self.state['collaborators'] = syncdata['collaborators']
if 'collaborator_states' in syncdata:
self.state['collaborator_states'] = syncdata['collaborator_states']
if 'day_orders' in syncdata:
self.state['day_orders'].update(syncdata['day_orders'])
if 'day_orders_timestamp' in syncdata:
self.state['day_orders_timestamp'] = syncdata[
'day_orders_timestamp']
if 'live_notifications_last_read_id' in syncdata:
self.state['live_notifications_last_read_id'] = \
syncdata['live_notifications_last_read_id']
if 'locations' in syncdata:
self.state['locations'] = syncdata['locations']
if 'settings' in syncdata:
self.state['settings'].update(syncdata['settings'])
if 'settings_notifications' in syncdata:
self.state['settings_notifications'].\
update(syncdata['settings_notifications'])
if 'user' in syncdata:
self.state['user'].update(syncdata['user'])
if 'web_static_version' in syncdata:
self.state['web_static_version'] = syncdata['web_static_version']
# Updating these type of data is a bit more complicated, since it is
# necessary to find out whether an object in the sync data is new,
# updates an existing object, or marks an object to be deleted. But
# the same procedure takes place for each of these types of data.
resp_models_mapping = [
('filters', models.Filter),
('items', models.Item),
('labels', models.Label),
('live_notifications', models.LiveNotification),
('notes', models.Note),
('project_notes', models.ProjectNote),
('projects', models.Project),
('reminders', models.Reminder),
]
for datatype, model in resp_models_mapping:
if datatype not in syncdata:
continue
# Process each object of this specific type in the sync data.
for remoteobj in syncdata[datatype]:
# Find out whether the object already exists in the local
# state.
localobj = self._find_object(datatype, remoteobj)
if localobj is not None:
# If the object is already present in the local state, then
# we either update it, or if marked as to be deleted, we
# remove it.
if remoteobj.get('is_deleted', 0) == 0:
localobj.data.update(remoteobj)
else:
self.state[datatype].remove(localobj)
else:
# If not, then the object is new and it should be added,
# unless it is marked as to be deleted (in which case it's
# ignored).
if remoteobj.get('is_deleted', 0) == 0:
newobj = model(remoteobj, self)
self.state[datatype].append(newobj)
def _find_object(self, objtype, obj):
"""
Searches for an object in the local state, depending on the type of
object, and then on its primary key is. If the object is found it is
returned, and if not, then None is returned.
"""
if objtype == 'collaborators':
return self.collaborators.get_by_id(obj['id'])
elif objtype == 'collaborator_states':
return self.collaborator_states.get_by_ids(obj['project_id'],
obj['user_id'])
elif objtype == 'filters':
return self.filters.get_by_id(obj['id'], only_local=True)
elif objtype == 'items':
return self.items.get_by_id(obj['id'], only_local=True)
elif objtype == 'labels':
return self.labels.get_by_id(obj['id'], only_local=True)
elif objtype == 'live_notifications':
return self.live_notifications.get_by_key(obj['notification_key'])
elif objtype == 'notes':
return self.notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'project_notes':
return self.project_notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'projects':
return self.projects.get_by_id(obj['id'], only_local=True)
elif objtype == 'reminders':
return self.reminders.get_by_id(obj['id'], only_local=True)
else:
return None
def _replace_temp_id(self, temp_id, new_id):
"""
Replaces the temporary id generated locally when an object was first
created, with a real Id supplied by the server. True is returned if
the temporary id was found and replaced, and False otherwise.
"""
# Go through all the objects for which we expect the temporary id to be
# replaced by a real one.
for datatype in [
'filters', 'items', 'labels', 'notes', 'project_notes',
'projects', 'reminders'
]:
for obj in self.state[datatype]:
if obj.temp_id == temp_id:
obj['id'] = new_id
return True
return False
def _get(self, call, url=None, **kwargs):
"""
Sends an HTTP GET request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.get(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _post(self, call, url=None, **kwargs):
"""
Sends an HTTP POST request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.post(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
# Sync
def generate_uuid(self):
"""
Generates a uuid.
"""
return str(uuid.uuid1())
def sync(self, commands=None):
"""
Sends to the server the changes that were made locally, and also
fetches the latest updated data from the server.
"""
post_data = {
'token': self.token,
'sync_token': self.sync_token,
'day_orders_timestamp': self.state['day_orders_timestamp'],
'include_notification_settings': 1,
'resource_types': json_dumps(['all']),
'commands': json_dumps(commands or []),
}
response = self._post('sync', data=post_data)
if 'temp_id_mapping' in response:
for temp_id, new_id in response['temp_id_mapping'].items():
self.temp_ids[temp_id] = new_id
self._replace_temp_id(temp_id, new_id)
self._update_state(response)
return response
def commit(self, raise_on_error=True):
"""
Commits all requests that are queued. Note that, without calling this
method none of the changes that are made to the objects are actually
synchronized to the server, unless one of the aforementioned Sync API
calls are called directly.
"""
if len(self.queue) == 0:
return
ret = self.sync(commands=self.queue)
del self.queue[:]
if 'sync_status' in ret:
if raise_on_error:
for k, v in ret['sync_status'].items():
if v != 'ok':
raise SyncError(k, v)
return ret
# Authentication
def login(self, email, password):
"""
Logins user, and returns the response received by the server.
"""
data = self._post('login', data={'email': email, 'password': password})
if 'token' in data:
self.token = data['token']
return data
def login_with_google(self, email, oauth2_token, **kwargs):
"""
Logins user with Google account, and returns the response received by
the server.
"""
data = {'email': email, 'oauth2_token': oauth2_token}
data.update(kwargs)
data = self._post('login_with_google', data=data)
if 'token' in data:
self.token = data['token']
return data
# User
def register(self, email, full_name, password, **kwargs):
"""
Registers a new user.
"""
data = {'email': email, 'full_name': full_name, 'password': password}
data.update(kwargs)
data = self._post('register', data=data)
if 'token' in data:
self.token = data['token']
return data
def delete_user(self, current_password, **kwargs):
"""
Deletes an existing user.
"""
params = {'token': self.token, 'current_password': current_password}
params.update(kwargs)
return self._get('delete_user', params=params)
# Miscellaneous
def upload_file(self, filename, **kwargs):
"""
Uploads a file.
"""
data = {'token': self.token}
data.update(kwargs)
files = {'file': open(filename, 'rb')}
return self._post('upload_file',
self.get_api_url(),
data=data,
files=files)
def query(self, queries, **kwargs):
"""
Performs date queries and other searches, and returns the results.
"""
params = {'queries': json_dumps(queries), 'token': self.token}
params.update(kwargs)
return self._get('query', params=params)
def get_redirect_link(self, **kwargs):
"""
Returns the absolute URL to redirect or to open in a browser.
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('get_redirect_link', params=params)
def get_productivity_stats(self):
"""
Returns the user's recent productivity stats.
"""
return self._get('get_productivity_stats',
params={'token': self.token})
def update_notification_setting(self, notification_type, service,
dont_notify):
"""
Updates the user's notification settings.
"""
return self._post('update_notification_setting',
data={
'token': self.token,
'notification_type': notification_type,
'service': service,
'dont_notify': dont_notify
})
def get_all_completed_items(self, **kwargs):
"""
Returns all user's completed items.
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('get_all_completed_items', params=params)
def get_completed_items(self, project_id, **kwargs):
"""
Returns a project's completed items.
"""
params = {'token': self.token, 'project_id': project_id}
params.update(kwargs)
return self._get('get_completed_items', params=params)
def get_uploads(self, **kwargs):
"""
Returns all user's uploads.
kwargs:
limit: (int, optional) number of results (1-50)
last_id: (int, optional) return results with id<last_id
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('uploads/get', params=params)
def delete_upload(self, file_url):
"""
Delete upload.
param file_url: (str) uploaded file URL
"""
params = {'token': self.token, 'file_url': file_url}
return self._get('uploads/delete', params=params)
def add_item(self, content, **kwargs):
"""
Adds a new task.
"""
params = {'token': self.token, 'content': content}
params.update(kwargs)
return self._get('add_item', params=params)
# Sharing
def share_project(self, project_id, email, message='', **kwargs):
"""
Appends a request to the queue, to share a project with a user.
"""
cmd = {
'type': 'share_project',
'temp_id': self.generate_uuid(),
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
'email': email,
},
}
cmd['args'].update(kwargs)
self.queue.append(cmd)
def delete_collaborator(self, project_id, email):
"""
Appends a request to the queue, to delete a collaborator from a shared
project.
"""
cmd = {
'type': 'delete_collaborator',
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
'email': email,
},
}
self.queue.append(cmd)
def take_ownership(self, project_id):
"""
Appends a request to the queue, take ownership of a shared project.
"""
cmd = {
'type': 'take_ownership',
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
},
}
self.queue.append(cmd)
# Auxiliary
def get_project(self, project_id):
"""
Gets an existing project.
"""
params = {'token': self.token, 'project_id': project_id}
obj = self._get('get_project', params=params)
if obj and 'error' in obj:
return None
data = {'projects': [], 'project_notes': []}
if obj.get('project'):
data['projects'].append(obj.get('project'))
if obj.get('notes'):
data['project_notes'] += obj.get('notes')
self._update_state(data)
return obj
def get_item(self, item_id):
"""
Gets an existing item.
"""
params = {'token': self.token, 'item_id': item_id}
obj = self._get('get_item', params=params)
if obj and 'error' in obj:
return None
data = {'projects': [], 'items': [], 'notes': []}
if obj.get('project'):
data['projects'].append(obj.get('project'))
if obj.get('item'):
data['items'].append(obj.get('item'))
if obj.get('notes'):
data['notes'] += obj.get('notes')
self._update_state(data)
return obj
def get_label(self, label_id):
"""
Gets an existing label.
"""
params = {'token': self.token, 'label_id': label_id}
obj = self._get('get_label', params=params)
if obj and 'error' in obj:
return None
data = {'labels': []}
if obj.get('label'):
data['labels'].append(obj.get('label'))
self._update_state(data)
return obj
def get_note(self, note_id):
"""
Gets an existing note.
"""
params = {'token': self.token, 'note_id': note_id}
obj = self._get('get_note', params=params)
if obj and 'error' in obj:
return None
data = {'notes': []}
if obj.get('note'):
data['notes'].append(obj.get('note'))
self._update_state(data)
return obj
def get_filter(self, filter_id):
"""
Gets an existing filter.
"""
params = {'token': self.token, 'filter_id': filter_id}
obj = self._get('get_filter', params=params)
if obj and 'error' in obj:
return None
data = {'filters': []}
if obj.get('filter'):
data['filters'].append(obj.get('filter'))
self._update_state(data)
return obj
def get_reminder(self, reminder_id):
"""
Gets an existing reminder.
"""
params = {'token': self.token, 'reminder_id': reminder_id}
obj = self._get('get_reminder', params=params)
if obj and 'error' in obj:
return None
data = {'reminders': []}
if obj.get('reminder'):
data['reminders'].append(obj.get('reminder'))
self._update_state(data)
return obj
# Templates
def import_template_into_project(self, project_id, filename, **kwargs):
"""
Imports a template into a project.
"""
data = {'token': self.token, 'project_id': project_id}
data.update(kwargs)
files = {'file': open(filename, 'r')}
return self._post('templates/import_into_project',
self.get_api_url(),
data=data,
files=files)
def export_template_as_file(self, project_id, **kwargs):
"""
Exports a template as a file.
"""
data = {'token': self.token, 'project_id': project_id}
data.update(kwargs)
return self._post('templates/export_as_file',
self.get_api_url(),
data=data)
def export_template_as_url(self, project_id, **kwargs):
"""
Exports a template as a URL.
"""
data = {'token': self.token, 'project_id': project_id}
data.update(kwargs)
return self._post('templates/export_as_url',
self.get_api_url(),
data=data)
# Business
def business_users_invite(self, email_list):
"""
Send a business user invitation.
"""
params = {'token': self.token, 'email_list': json.dumps(email_list)}
return self._get('business/users/invite', params=params)
def business_users_accept_invitation(self, id, secret):
"""
Accept a business user invitation.
"""
params = {'token': self.token, 'id': id, 'secret': secret}
return self._get('business/users/accept_invitation', params=params)
def business_users_reject_invitation(self, id, secret):
"""
Reject a business user invitation.
"""
params = {'token': self.token, 'id': id, 'secret': secret}
return self._get('business/users/reject_invitation', params=params)
# Class
def __repr__(self):
name = self.__class__.__name__
unsaved = '*' if len(self.queue) > 0 else ''
email = self.user.get('email')
email_repr = repr(email) if email else '<not synchronized>'
return '%s%s(%s)' % (name, unsaved, email_repr)
class TodoistAPI(object):
"""
Implements the API that makes it possible to interact with a Todoist user
account and its data.
"""
_serialize_fields = ('token', 'api_endpoint', 'sync_token', 'state',
'temp_ids')
@classmethod
def deserialize(cls, data):
obj = cls()
for key in cls._serialize_fields:
if key in data:
setattr(obj, key, data[key])
return obj
def __init__(self,
token='',
api_endpoint='https://todoist.com',
session=None,
cache='~/.todoist-sync/'):
self.api_endpoint = api_endpoint
self.reset_state()
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session(
) # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
self.completed = CompletedManager(self)
self.uploads = UploadsManager(self)
self.activity = ActivityManager(self)
self.business_users = BusinessUsersManager(self)
self.templates = TemplatesManager(self)
self.backups = BackupsManager(self)
if cache: # Read and write user state on local disk cache
self.cache = os.path.expanduser(cache)
self._read_cache()
else:
self.cache = None
def reset_state(self):
self.sync_token = '*'
self.state = { # Local copy of all of the user's objects
'collaborator_states': [],
'collaborators': [],
'day_orders': {},
'day_orders_timestamp': '',
'filters': [],
'items': [],
'labels': [],
'live_notifications': [],
'live_notifications_last_read_id': -1,
'locations': [],
'notes': [],
'project_notes': [],
'projects': [],
'reminders': [],
'settings_notifications': {},
'user': {},
}
def __getitem__(self, key):
return self.state[key]
def serialize(self):
return {key: getattr(self, key) for key in self._serialize_fields}
def get_api_url(self):
return '%s/API/v7/' % self.api_endpoint
def _update_state(self, syncdata):
"""
Updates the local state, with the data returned by the server after a
sync.
"""
# Check sync token first
if 'sync_token' in syncdata:
self.sync_token = syncdata['sync_token']
# It is straightforward to update these type of data, since it is
# enough to just see if they are present in the sync data, and then
# either replace the local values or update them.
if 'day_orders' in syncdata:
self.state['day_orders'].update(syncdata['day_orders'])
if 'day_orders_timestamp' in syncdata:
self.state['day_orders_timestamp'] = syncdata[
'day_orders_timestamp']
if 'live_notifications_last_read_id' in syncdata:
self.state['live_notifications_last_read_id'] = syncdata[
'live_notifications_last_read_id']
if 'locations' in syncdata:
self.state['locations'] = syncdata['locations']
if 'settings_notifications' in syncdata:
self.state['settings_notifications'].update(
syncdata['settings_notifications'])
if 'user' in syncdata:
self.state['user'].update(syncdata['user'])
# Updating these type of data is a bit more complicated, since it is
# necessary to find out whether an object in the sync data is new,
# updates an existing object, or marks an object to be deleted. But
# the same procedure takes place for each of these types of data.
resp_models_mapping = [
('collaborator', models.Collaborator),
('collaborator_states', models.CollaboratorState),
('filters', models.Filter),
('items', models.Item),
('labels', models.Label),
('live_notifications', models.LiveNotification),
('notes', models.Note),
('project_notes', models.ProjectNote),
('projects', models.Project),
('reminders', models.Reminder),
]
for datatype, model in resp_models_mapping:
if datatype not in syncdata:
continue
# Process each object of this specific type in the sync data.
for remoteobj in syncdata[datatype]:
# Find out whether the object already exists in the local
# state.
localobj = self._find_object(datatype, remoteobj)
if localobj is not None:
# If the object is already present in the local state, then
# we either update it, or if marked as to be deleted, we
# remove it.
is_deleted = remoteobj.get('is_deleted', 0)
if is_deleted == 0 or is_deleted is False:
localobj.data.update(remoteobj)
else:
self.state[datatype].remove(localobj)
else:
# If not, then the object is new and it should be added,
# unless it is marked as to be deleted (in which case it's
# ignored).
is_deleted = remoteobj.get('is_deleted', 0)
if is_deleted == 0 or is_deleted is False:
newobj = model(remoteobj, self)
self.state[datatype].append(newobj)
def _read_cache(self):
if not self.cache:
return
try:
os.makedirs(self.cache)
except OSError:
if not os.path.isdir(self.cache):
raise
try:
with open(self.cache + self.token + '.json') as f:
state = f.read()
state = json.loads(state)
self._update_state(state)
with open(self.cache + self.token + '.sync') as f:
sync_token = f.read()
self.sync_token = sync_token
except:
return
def _write_cache(self):
if not self.cache:
return
result = json.dumps(self.state,
indent=2,
sort_keys=True,
default=state_default)
with open(self.cache + self.token + '.json', 'w') as f:
f.write(result)
with open(self.cache + self.token + '.sync', 'w') as f:
f.write(self.sync_token)
def _find_object(self, objtype, obj):
"""
Searches for an object in the local state, depending on the type of
object, and then on its primary key is. If the object is found it is
returned, and if not, then None is returned.
"""
if objtype == 'collaborators':
return self.collaborators.get_by_id(obj['id'])
elif objtype == 'collaborator_states':
return self.collaborator_states.get_by_ids(obj['project_id'],
obj['user_id'])
elif objtype == 'filters':
return self.filters.get_by_id(obj['id'], only_local=True)
elif objtype == 'items':
return self.items.get_by_id(obj['id'], only_local=True)
elif objtype == 'labels':
return self.labels.get_by_id(obj['id'], only_local=True)
elif objtype == 'live_notifications':
return self.live_notifications.get_by_id(obj['id'])
elif objtype == 'notes':
return self.notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'project_notes':
return self.project_notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'projects':
return self.projects.get_by_id(obj['id'], only_local=True)
elif objtype == 'reminders':
return self.reminders.get_by_id(obj['id'], only_local=True)
else:
return None
def _replace_temp_id(self, temp_id, new_id):
"""
Replaces the temporary id generated locally when an object was first
created, with a real Id supplied by the server. True is returned if
the temporary id was found and replaced, and False otherwise.
"""
# Go through all the objects for which we expect the temporary id to be
# replaced by a real one.
for datatype in [
'filters', 'items', 'labels', 'notes', 'project_notes',
'projects', 'reminders'
]:
for obj in self.state[datatype]:
if obj.temp_id == temp_id:
obj['id'] = new_id
return True
return False
def _get(self, call, url=None, **kwargs):
"""
Sends an HTTP GET request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.get(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _post(self, call, url=None, **kwargs):
"""
Sends an HTTP POST request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.post(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
# Sync
def generate_uuid(self):
"""
Generates a uuid.
"""
return str(uuid.uuid1())
def sync(self, commands=None):
"""
Sends to the server the changes that were made locally, and also
fetches the latest updated data from the server.
"""
post_data = {
'token': self.token,
'sync_token': self.sync_token,
'day_orders_timestamp': self.state['day_orders_timestamp'],
'include_notification_settings': 1,
'resource_types': json_dumps(['all']),
'commands': json_dumps(commands or []),
}
response = self._post('sync', data=post_data)
if 'temp_id_mapping' in response:
for temp_id, new_id in response['temp_id_mapping'].items():
self.temp_ids[temp_id] = new_id
self._replace_temp_id(temp_id, new_id)
self._update_state(response)
self._write_cache()
return response
def commit(self, raise_on_error=True):
"""
Commits all requests that are queued. Note that, without calling this
method none of the changes that are made to the objects are actually
synchronized to the server, unless one of the aforementioned Sync API
calls are called directly.
"""
if len(self.queue) == 0:
return
ret = self.sync(commands=self.queue)
del self.queue[:]
if 'sync_status' in ret:
if raise_on_error:
for k, v in ret['sync_status'].items():
if v != 'ok':
raise SyncError(k, v)
return ret
# Miscellaneous
def query(self, queries, **kwargs):
"""
Performs date queries and other searches, and returns the results.
"""
params = {'queries': json_dumps(queries), 'token': self.token}
params.update(kwargs)
return self._get('query', params=params)
def add_item(self, content, **kwargs):
"""
Adds a new task.
"""
params = {'token': self.token, 'content': content}
params.update(kwargs)
if 'labels' in params:
params['labels'] = str(params['labels'])
return self._get('add_item', params=params)
# Class
def __repr__(self):
name = self.__class__.__name__
unsaved = '*' if len(self.queue) > 0 else ''
email = self.user.get('email')
email_repr = repr(email) if email else '<not synchronized>'
return '%s%s(%s)' % (name, unsaved, email_repr)
class TodoistAPI(object):
"""
Implements the API that makes it possible to interact with a Todoist user
account and its data.
"""
_serialize_fields = ('token', 'api_endpoint', 'seq_no', 'seq_no_partial',
'seq_no_global', 'seq_no_global_partial', 'state',
'temp_ids')
@classmethod
def deserialize(cls, data):
obj = cls()
for key in cls._serialize_fields:
if key in data:
setattr(obj, key, data[key])
return obj
def __init__(self,
token='',
api_endpoint='https://api.todoist.com',
session=None):
self.api_endpoint = api_endpoint
self.seq_no = 0 # Sequence number since last update
self.seq_no_partial = {} # Sequence number of partial syncs
self.seq_no_global = 0 # Global sequence number since last update
self.seq_no_global_partial = {
} # Global sequence number of partial syncs
self.state = { # Local copy of all of the user's objects
'CollaboratorStates': [],
'Collaborators': [],
'DayOrders': {},
'DayOrdersTimestamp': '',
'Filters': [],
'Items': [],
'Labels': [],
'LiveNotifications': [],
'LiveNotificationsLastRead': -1,
'Locations': [],
'Notes': [],
'ProjectNotes': [],
'Projects': [],
'Reminders': [],
'Settings': {},
'SettingsNotifications': {},
'User': {},
'UserId': -1,
'WebStaticVersion': -1,
}
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session(
) # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
def __getitem__(self, key):
return self.state[key]
def serialize(self):
return {key: getattr(self, key) for key in self._serialize_fields}
def get_api_url(self):
return '%s/API/v6/' % self.api_endpoint
def _update_state(self, syncdata):
"""
Updates the local state, with the data returned by the server after a
sync.
"""
# It is straightforward to update these type of data, since it is
# enough to just see if they are present in the sync data, and then
# either replace the local values or update them.
if 'Collaborators' in syncdata:
self.state['Collaborators'] = syncdata['Collaborators']
if 'CollaboratorStates' in syncdata:
self.state['CollaboratorStates'] = syncdata['CollaboratorStates']
if 'DayOrders' in syncdata:
self.state['DayOrders'].update(syncdata['DayOrders'])
if 'DayOrdersTimestamp' in syncdata:
self.state['DayOrdersTimestamp'] = syncdata['DayOrdersTimestamp']
if 'LiveNotificationsLastRead' in syncdata:
self.state['LiveNotificationsLastRead'] = \
syncdata['LiveNotificationsLastRead']
if 'Locations' in syncdata:
self.state['Locations'] = syncdata['Locations']
if 'Settings' in syncdata:
self.state['Settings'].update(syncdata['Settings'])
if 'SettingsNotifications' in syncdata:
self.state['SettingsNotifications'].\
update(syncdata['SettingsNotifications'])
if 'User' in syncdata:
self.state['User'].update(syncdata['User'])
if 'UserId' in syncdata:
self.state['UserId'] = syncdata['UserId']
if 'WebStaticVersion' in syncdata:
self.state['WebStaticVersion'] = syncdata['WebStaticVersion']
# Updating these type of data is a bit more complicated, since it is
# necessary to find out whether an object in the sync data is new,
# updates an existing object, or marks an object to be deleted. But
# the same procedure takes place for each of these types of data.
for datatype in 'Filters', 'Items', 'Labels', 'LiveNotifications', \
'Notes', 'ProjectNotes', 'Projects', 'Reminders':
if datatype not in syncdata:
continue
# Process each object of this specific type in the sync data.
for remoteobj in syncdata[datatype]:
# Find out whether the object already exists in the local
# state.
localobj = self._find_object(datatype, remoteobj)
if localobj is not None:
# If the object is already present in the local state, then
# we either update it, or if marked as to be deleted, we
# remove it.
if remoteobj.get('is_deleted', 0) == 0:
localobj.data.update(remoteobj)
else:
self.state[datatype].remove(localobj)
else:
# If not, then the object is new and it should be added,
# unless it is marked as to be deleted (in which case it's
# ignored).
if remoteobj.get('is_deleted', 0) == 0:
model = 'models.' + datatype[:-1]
newobj = eval(model)(remoteobj, self)
self.state[datatype].append(newobj)
def _find_object(self, objtype, obj):
"""
Searches for an object in the local state, depending on the type of
object, and then on its primary key is. If the object is found it is
returned, and if not, then None is returned.
"""
if objtype == 'Collaborators':
return self.collaborators.get_by_id(obj['id'])
elif objtype == 'CollaboratorStates':
return self.collaborator_states.get_by_ids(obj['project_id'],
obj['user_id'])
elif objtype == 'Filters':
return self.filters.get_by_id(obj['id'], only_local=True)
elif objtype == 'Items':
return self.items.get_by_id(obj['id'], only_local=True)
elif objtype == 'Labels':
return self.labels.get_by_id(obj['id'], only_local=True)
elif objtype == 'LiveNotifications':
return self.live_notifications.get_by_key(obj['notification_key'])
elif objtype == 'Notes':
return self.notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'ProjectNotes':
return self.project_notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'Projects':
return self.projects.get_by_id(obj['id'], only_local=True)
elif objtype == 'Reminders':
return self.reminders.get_by_id(obj['id'], only_local=True)
else:
return None
def _get_seq_no(self, resource_types):
"""
Calculates what is the seq_no that should be sent, based on the last
seq_no and the resource_types that are requested.
"""
seq_no = -1
seq_no_global = -1
if resource_types:
for resource in resource_types:
if resource not in self.seq_no_partial:
seq_no = self.seq_no
else:
if seq_no == -1 or self.seq_no_partial[resource] < seq_no:
seq_no = self.seq_no_partial[resource]
if resource not in self.seq_no_global_partial:
seq_no_global = self.seq_no_global
else:
if seq_no_global == -1 or \
self.seq_no_global_partial[resource] < seq_no_global:
seq_no_global = self.seq_no_global_partial[resource]
if seq_no == -1:
seq_no = self.seq_no
if seq_no_global == -1:
seq_no_global = self.seq_no_global
return seq_no, seq_no_global
def _update_seq_no(self, seq_no, seq_no_global, resource_types):
"""
Updates the seq_no and the seq_no_partial, based on the seq_no in
the response and the resource_types that were requested.
"""
if not seq_no and not seq_no_global or not resource_types:
return
if 'all' in resource_types:
if seq_no:
self.seq_no = seq_no
self.seq_no_partial = {}
if seq_no_global:
self.seq_no_global = seq_no_global
self.seq_no_global_partial = {}
else:
if seq_no and seq_no > self.seq_no:
for resource in resource_types:
self.seq_no_partial[resource] = seq_no
if seq_no_global and seq_no_global > self.seq_no_global:
for resource in resource_types:
self.seq_no_global_partial[resource] = seq_no_global
def _replace_temp_id(self, temp_id, new_id):
"""
Replaces the temporary id generated locally when an object was first
created, with a real Id supplied by the server. True is returned if
the temporary id was found and replaced, and False otherwise.
"""
# Go through all the objects for which we expect the temporary id to be
# replaced by a real one.
for datatype in [
'Filters', 'Items', 'Labels', 'Notes', 'ProjectNotes',
'Projects', 'Reminders'
]:
for obj in self.state[datatype]:
if obj.temp_id == temp_id:
obj['id'] = new_id
return True
return False
def _get(self, call, url=None, **kwargs):
"""
Sends an HTTP GET request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.get(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _post(self, call, url=None, **kwargs):
"""
Sends an HTTP POST request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.post(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _json_serializer(self, obj):
import datetime
if isinstance(obj, datetime.datetime):
return obj.strftime('%Y-%m-%dT%H:%M:%S')
elif isinstance(obj, datetime.date):
return obj.strftime('%Y-%m-%d')
elif isinstance(obj, datetime.time):
return obj.strftime('%H:%M:%S')
# Sync
def generate_uuid(self):
"""
Generates a uuid.
"""
return str(uuid.uuid1())
def sync(self, commands=None, **kwargs):
"""
Sends to the server the changes that were made locally, and also
fetches the latest updated data from the server.
"""
data = {
'token':
self.token,
'commands':
json.dumps(commands or [],
separators=',:',
default=self._json_serializer),
'day_orders_timestamp':
self.state['DayOrdersTimestamp'],
}
if not commands:
data['seq_no'], data['seq_no_global'] = \
self._get_seq_no(kwargs.get('resource_types', None))
if 'include_notification_settings' in kwargs:
data['include_notification_settings'] = 1
if 'resource_types' in kwargs:
data['resource_types'] = json.dumps(kwargs['resource_types'],
separators=',:')
data = self._post('sync', data=data)
self._update_state(data)
if not commands:
self._update_seq_no(data.get('seq_no', None),
data.get('seq_no_global', None),
kwargs.get('resource_types', None))
return data
def commit(self):
"""
Commits all requests that are queued. Note that, without calling this
method none of the changes that are made to the objects are actually
synchronized to the server, unless one of the aforementioned Sync API
calls are called directly.
"""
if len(self.queue) == 0:
return
ret = self.sync(commands=self.queue)
del self.queue[:]
if 'TempIdMapping' in ret:
for temp_id, new_id in ret['TempIdMapping'].items():
self.temp_ids[temp_id] = new_id
self._replace_temp_id(temp_id, new_id)
if 'SyncStatus' in ret:
return ret['SyncStatus']
return ret
# Authentication
def login(self, email, password):
"""
Logins user, and returns the response received by the server.
"""
data = self._post('login', data={'email': email, 'password': password})
if 'token' in data:
self.token = data['token']
return data
def login_with_google(self, email, oauth2_token, **kwargs):
"""
Logins user with Google account, and returns the response received by
the server.
"""
data = {'email': email, 'oauth2_token': oauth2_token}
data.update(kwargs)
data = self._post('login_with_google', data=data)
if 'token' in data:
self.token = data['token']
return data
# User
def register(self, email, full_name, password, **kwargs):
"""
Registers a new user.
"""
data = {'email': email, 'full_name': full_name, 'password': password}
data.update(kwargs)
data = self._post('register', data=data)
if 'token' in data:
self.token = data['token']
return data
def delete_user(self, current_password, **kwargs):
"""
Deletes an existing user.
"""
params = {'token': self.token, 'current_password': current_password}
params.update(kwargs)
return self._get('delete_user', params=params)
# Miscellaneous
def upload_file(self, filename, **kwargs):
"""
Uploads a file.
"""
data = {'token': self.token}
data.update(kwargs)
files = {'file': open(filename, 'rb')}
return self._post('upload_file',
self.get_api_url(),
data=data,
files=files)
def query(self, queries, **kwargs):
"""
Performs date queries and other searches, and returns the results.
"""
params = {
'queries':
json.dumps(queries, separators=',:',
default=self._json_serializer),
'token':
self.token
}
params.update(kwargs)
return self._get('query', params=params)
def get_redirect_link(self, **kwargs):
"""
Returns the absolute URL to redirect or to open in a browser.
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('get_redirect_link', params=params)
def get_productivity_stats(self):
"""
Returns the user's recent productivity stats.
"""
return self._get('get_productivity_stats',
params={'token': self.token})
def update_notification_setting(self, notification_type, service,
dont_notify):
"""
Updates the user's notification settings.
"""
return self._post('update_notification_setting',
data={
'token': self.token,
'notification_type': notification_type,
'service': service,
'dont_notify': dont_notify
})
def get_all_completed_items(self, **kwargs):
"""
Returns all user's completed items.
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('get_all_completed_items', params=params)
def get_completed_items(self, project_id, **kwargs):
"""
Returns a project's completed items.
"""
params = {'token': self.token, 'project_id': project_id}
params.update(kwargs)
return self._get('get_completed_items', params=params)
def add_item(self, content, **kwargs):
"""
Adds a new task.
"""
params = {'token': self.token, 'content': content}
params.update(kwargs)
return self._get('add_item', params=params)
# Sharing
def share_project(self, project_id, email, message='', **kwargs):
"""
Appends a request to the queue, to share a project with a user.
"""
cmd = {
'type': 'share_project',
'temp_id': self.generate_uuid(),
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
'email': email,
},
}
cmd['args'].update(kwargs)
self.queue.append(cmd)
def delete_collaborator(self, project_id, email):
"""
Appends a request to the queue, to delete a collaborator from a shared
project.
"""
cmd = {
'type': 'delete_collaborator',
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
'email': email,
},
}
self.queue.append(cmd)
def take_ownership(self, project_id):
"""
Appends a request to the queue, take ownership of a shared project.
"""
cmd = {
'type': 'take_ownership',
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
},
}
self.queue.append(cmd)
# Auxiliary
def get_project(self, project_id):
"""
Gets an existing project.
"""
params = {'token': self.token, 'project_id': project_id}
data = self._get('get_project', params=params)
obj = data.get('project', None)
if obj and 'error' not in obj:
self._update_state({'Projects': [obj]})
return [o for o in self.state['Projects']
if o['id'] == obj['id']][0]
return None
def get_item(self, item_id):
"""
Gets an existing item.
"""
params = {'token': self.token, 'item_id': item_id}
data = self._get('get_item', params=params)
obj = data.get('item', None)
if obj and 'error' not in obj:
self._update_state({'Items': [obj]})
return [o for o in self.state['Items'] if o['id'] == obj['id']][0]
return None
def get_label(self, label_id):
"""
Gets an existing label.
"""
params = {'token': self.token, 'label_id': label_id}
data = self._get('get_label', params=params)
obj = data.get('label', None)
if obj and 'error' not in obj:
self._update_state({'Labels': [obj]})
return [o for o in self.state['Labels'] if o['id'] == obj['id']][0]
return None
def get_note(self, note_id):
"""
Gets an existing note.
"""
params = {'token': self.token, 'note_id': note_id}
data = self._get('get_note', params=params)
obj = data.get('note', None)
if obj and 'error' not in obj:
self._update_state({'Notes': [obj]})
return [o for o in self.state['Notes'] if o['id'] == obj['id']][0]
return None
def get_filter(self, filter_id):
"""
Gets an existing filter.
"""
params = {'token': self.token, 'filter_id': filter_id}
data = self._get('get_filter', params=params)
obj = data.get('filter', None)
if obj and 'error' not in obj:
self._update_state({'Filters': [obj]})
return [o for o in self.state['Filters']
if o['id'] == obj['id']][0]
return None
def get_reminder(self, reminder_id):
"""
Gets an existing reminder.
"""
params = {'token': self.token, 'reminder_id': reminder_id}
data = self._get('get_reminder', params=params)
obj = data.get('reminder', None)
if obj and 'error' not in obj:
self._update_state({'Reminders': [obj]})
return [
o for o in self.state['Reminders'] if o['id'] == obj['id']
][0]
return None
# Class
def __repr__(self):
name = self.__class__.__name__
unsaved = '*' if len(self.queue) > 0 else ''
email = self.user.get('email')
email_repr = repr(email) if email else '<not synchronized>'
return '%s%s(%s)' % (name, unsaved, email_repr)
class TodoistAPI(object):
"""
Implements the API that makes it possible to interact with a Todoist user
account and its data.
"""
_serialize_fields = ('token', 'api_endpoint', 'seq_no', 'seq_no_partial',
'seq_no_global', 'seq_no_global_partial', 'state',
'temp_ids')
@classmethod
def deserialize(cls, data):
obj = cls()
for key in cls._serialize_fields:
if key in data:
setattr(obj, key, data[key])
return obj
def __init__(self, token='', api_endpoint='https://api.todoist.com', session=None):
self.api_endpoint = api_endpoint
self.seq_no = 0 # Sequence number since last update
self.seq_no_partial = {} # Sequence number of partial syncs
self.seq_no_global = 0 # Global sequence number since last update
self.seq_no_global_partial = {} # Global sequence number of partial syncs
self.state = { # Local copy of all of the user's objects
'CollaboratorStates': [],
'Collaborators': [],
'DayOrders': {},
'DayOrdersTimestamp': '',
'Filters': [],
'Items': [],
'Labels': [],
'LiveNotifications': [],
'LiveNotificationsLastRead': -1,
'Locations': [],
'Notes': [],
'ProjectNotes': [],
'Projects': [],
'Reminders': [],
'Settings': {},
'SettingsNotifications': {},
'User': {},
'UserId': -1,
'WebStaticVersion': -1,
}
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session() # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
def __getitem__(self, key):
return self.state[key]
def serialize(self):
return {key: getattr(self, key) for key in self._serialize_fields}
def get_api_url(self):
return '%s/API/v6/' % self.api_endpoint
def _update_state(self, syncdata):
"""
Updates the local state, with the data returned by the server after a
sync.
"""
# It is straightforward to update these type of data, since it is
# enough to just see if they are present in the sync data, and then
# either replace the local values or update them.
if 'Collaborators' in syncdata:
self.state['Collaborators'] = syncdata['Collaborators']
if 'CollaboratorStates' in syncdata:
self.state['CollaboratorStates'] = syncdata['CollaboratorStates']
if 'DayOrders' in syncdata:
self.state['DayOrders'].update(syncdata['DayOrders'])
if 'DayOrdersTimestamp' in syncdata:
self.state['DayOrdersTimestamp'] = syncdata['DayOrdersTimestamp']
if 'LiveNotificationsLastRead' in syncdata:
self.state['LiveNotificationsLastRead'] = \
syncdata['LiveNotificationsLastRead']
if 'Locations' in syncdata:
self.state['Locations'] = syncdata['Locations']
if 'Settings' in syncdata:
self.state['Settings'].update(syncdata['Settings'])
if 'SettingsNotifications' in syncdata:
self.state['SettingsNotifications'].\
update(syncdata['SettingsNotifications'])
if 'User' in syncdata:
self.state['User'].update(syncdata['User'])
if 'UserId' in syncdata:
self.state['UserId'] = syncdata['UserId']
if 'WebStaticVersion' in syncdata:
self.state['WebStaticVersion'] = syncdata['WebStaticVersion']
# Updating these type of data is a bit more complicated, since it is
# necessary to find out whether an object in the sync data is new,
# updates an existing object, or marks an object to be deleted. But
# the same procedure takes place for each of these types of data.
for datatype in 'Filters', 'Items', 'Labels', 'LiveNotifications', \
'Notes', 'ProjectNotes', 'Projects', 'Reminders':
if datatype not in syncdata:
continue
# Process each object of this specific type in the sync data.
for remoteobj in syncdata[datatype]:
# Find out whether the object already exists in the local
# state.
localobj = self._find_object(datatype, remoteobj)
if localobj is not None:
# If the object is already present in the local state, then
# we either update it, or if marked as to be deleted, we
# remove it.
if remoteobj.get('is_deleted', 0) == 0:
localobj.data.update(remoteobj)
else:
self.state[datatype].remove(localobj)
else:
# If not, then the object is new and it should be added,
# unless it is marked as to be deleted (in which case it's
# ignored).
if remoteobj.get('is_deleted', 0) == 0:
model = 'models.' + datatype[:-1]
newobj = eval(model)(remoteobj, self)
self.state[datatype].append(newobj)
def _find_object(self, objtype, obj):
"""
Searches for an object in the local state, depending on the type of
object, and then on its primary key is. If the object is found it is
returned, and if not, then None is returned.
"""
if objtype == 'Collaborators':
return self.collaborators.get_by_id(obj['id'])
elif objtype == 'CollaboratorStates':
return self.collaborator_states.get_by_ids(obj['project_id'],
obj['user_id'])
elif objtype == 'Filters':
return self.filters.get_by_id(obj['id'], only_local=True)
elif objtype == 'Items':
return self.items.get_by_id(obj['id'], only_local=True)
elif objtype == 'Labels':
return self.labels.get_by_id(obj['id'], only_local=True)
elif objtype == 'LiveNotifications':
return self.live_notifications.get_by_key(obj['notification_key'])
elif objtype == 'Notes':
return self.notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'ProjectNotes':
return self.project_notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'Projects':
return self.projects.get_by_id(obj['id'], only_local=True)
elif objtype == 'Reminders':
return self.reminders.get_by_id(obj['id'], only_local=True)
else:
return None
def _get_seq_no(self, resource_types):
"""
Calculates what is the seq_no that should be sent, based on the last
seq_no and the resource_types that are requested.
"""
seq_no = -1
seq_no_global = -1
if resource_types:
for resource in resource_types:
if resource not in self.seq_no_partial:
seq_no = self.seq_no
else:
if seq_no == -1 or self.seq_no_partial[resource] < seq_no:
seq_no = self.seq_no_partial[resource]
if resource not in self.seq_no_global_partial:
seq_no_global = self.seq_no_global
else:
if seq_no_global == -1 or \
self.seq_no_global_partial[resource] < seq_no_global:
seq_no_global = self.seq_no_global_partial[resource]
if seq_no == -1:
seq_no = self.seq_no
if seq_no_global == -1:
seq_no_global = self.seq_no_global
return seq_no, seq_no_global
def _update_seq_no(self, seq_no, seq_no_global, resource_types):
"""
Updates the seq_no and the seq_no_partial, based on the seq_no in
the response and the resource_types that were requested.
"""
if not seq_no and not seq_no_global or not resource_types:
return
if 'all' in resource_types:
if seq_no:
self.seq_no = seq_no
self.seq_no_partial = {}
if seq_no_global:
self.seq_no_global = seq_no_global
self.seq_no_global_partial = {}
else:
if seq_no and seq_no > self.seq_no:
for resource in resource_types:
self.seq_no_partial[resource] = seq_no
if seq_no_global and seq_no_global > self.seq_no_global:
for resource in resource_types:
self.seq_no_global_partial[resource] = seq_no_global
def _replace_temp_id(self, temp_id, new_id):
"""
Replaces the temporary id generated locally when an object was first
created, with a real Id supplied by the server. True is returned if
the temporary id was found and replaced, and False otherwise.
"""
# Go through all the objects for which we expect the temporary id to be
# replaced by a real one.
for datatype in ['Filters', 'Items', 'Labels', 'Notes', 'ProjectNotes',
'Projects', 'Reminders']:
for obj in self.state[datatype]:
if obj.temp_id == temp_id:
obj['id'] = new_id
return True
return False
def _get(self, call, url=None, **kwargs):
"""
Sends an HTTP GET request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.get(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _post(self, call, url=None, **kwargs):
"""
Sends an HTTP POST request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.post(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _json_serializer(self, obj):
import datetime
if isinstance(obj, datetime.datetime):
return obj.strftime('%Y-%m-%dT%H:%M:%S')
elif isinstance(obj, datetime.date):
return obj.strftime('%Y-%m-%d')
elif isinstance(obj, datetime.time):
return obj.strftime('%H:%M:%S')
# Sync
def generate_uuid(self):
"""
Generates a uuid.
"""
return str(uuid.uuid1())
def sync(self, commands=None, **kwargs):
"""
Sends to the server the changes that were made locally, and also
fetches the latest updated data from the server.
"""
data = {
'token': self.token,
'commands': json.dumps(commands or [], separators=',:',
default=self._json_serializer),
'day_orders_timestamp': self.state['DayOrdersTimestamp'],
}
if not commands:
data['seq_no'], data['seq_no_global'] = \
self._get_seq_no(kwargs.get('resource_types', None))
if 'include_notification_settings' in kwargs:
data['include_notification_settings'] = 1
if 'resource_types' in kwargs:
data['resource_types'] = json.dumps(kwargs['resource_types'],
separators=',:')
data = self._post('sync', data=data)
self._update_state(data)
if not commands:
self._update_seq_no(data.get('seq_no', None),
data.get('seq_no_global', None),
kwargs.get('resource_types', None))
return data
def commit(self):
"""
Commits all requests that are queued. Note that, without calling this
method none of the changes that are made to the objects are actually
synchronized to the server, unless one of the aforementioned Sync API
calls are called directly.
"""
if len(self.queue) == 0:
return
ret = self.sync(commands=self.queue)
del self.queue[:]
if 'TempIdMapping' in ret:
for temp_id, new_id in ret['TempIdMapping'].items():
self.temp_ids[temp_id] = new_id
self._replace_temp_id(temp_id, new_id)
if 'SyncStatus' in ret:
return ret['SyncStatus']
return ret
# Authentication
def login(self, email, password):
"""
Logins user, and returns the response received by the server.
"""
data = self._post('login', data={'email': email,
'password': password})
if 'token' in data:
self.token = data['token']
return data
def login_with_google(self, email, oauth2_token, **kwargs):
"""
Logins user with Google account, and returns the response received by
the server.
"""
data = {'email': email, 'oauth2_token': oauth2_token}
data.update(kwargs)
data = self._post('login_with_google', data=data)
if 'token' in data:
self.token = data['token']
return data
# User
def register(self, email, full_name, password, **kwargs):
"""
Registers a new user.
"""
data = {'email': email, 'full_name': full_name, 'password': password}
data.update(kwargs)
data = self._post('register', data=data)
if 'token' in data:
self.token = data['token']
return data
def delete_user(self, current_password, **kwargs):
"""
Deletes an existing user.
"""
params = {'token': self.token,
'current_password': current_password}
params.update(kwargs)
return self._get('delete_user', params=params)
# Miscellaneous
def upload_file(self, filename, **kwargs):
"""
Uploads a file.
"""
data = {'token': self.token}
data.update(kwargs)
files = {'file': open(filename, 'rb')}
return self._post('upload_file', self.get_api_url(), data=data,
files=files)
def query(self, queries, **kwargs):
"""
Performs date queries and other searches, and returns the results.
"""
params = {'queries': json.dumps(queries, separators=',:',
default=self._json_serializer),
'token': self.token}
params.update(kwargs)
return self._get('query', params=params)
def get_redirect_link(self, **kwargs):
"""
Returns the absolute URL to redirect or to open in a browser.
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('get_redirect_link', params=params)
def get_productivity_stats(self):
"""
Returns the user's recent productivity stats.
"""
return self._get('get_productivity_stats',
params={'token': self.token})
def update_notification_setting(self, notification_type, service,
dont_notify):
"""
Updates the user's notification settings.
"""
return self._post('update_notification_setting',
data={'token': self.token,
'notification_type': notification_type,
'service': service,
'dont_notify': dont_notify})
def get_all_completed_items(self, **kwargs):
"""
Returns all user's completed items.
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('get_all_completed_items', params=params)
def get_completed_items(self, project_id, **kwargs):
"""
Returns a project's completed items.
"""
params = {'token': self.token,
'project_id': project_id}
params.update(kwargs)
return self._get('get_completed_items', params=params)
def get_uploads(self, **kwargs):
"""
Returns all user's uploads.
kwargs:
limit: (int, optional) number of results (1-50)
last_id: (int, optional) return results with id<last_id
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('uploads/get', params=params)
def delete_upload(self, file_url):
"""
Delete upload.
param file_url: (str) uploaded file URL
"""
params = {'token': self.token, 'file_url': file_url}
return self._get('uploads/delete', params=params)
def add_item(self, content, **kwargs):
"""
Adds a new task.
"""
params = {'token': self.token,
'content': content}
params.update(kwargs)
return self._get('add_item', params=params)
# Sharing
def share_project(self, project_id, email, message='', **kwargs):
"""
Appends a request to the queue, to share a project with a user.
"""
cmd = {
'type': 'share_project',
'temp_id': self.generate_uuid(),
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
'email': email,
},
}
cmd['args'].update(kwargs)
self.queue.append(cmd)
def delete_collaborator(self, project_id, email):
"""
Appends a request to the queue, to delete a collaborator from a shared
project.
"""
cmd = {
'type': 'delete_collaborator',
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
'email': email,
},
}
self.queue.append(cmd)
def take_ownership(self, project_id):
"""
Appends a request to the queue, take ownership of a shared project.
"""
cmd = {
'type': 'take_ownership',
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
},
}
self.queue.append(cmd)
# Auxiliary
def get_project(self, project_id):
"""
Gets an existing project.
"""
params = {'token': self.token,
'project_id': project_id}
data = self._get('get_project', params=params)
obj = data.get('project', None)
if obj and 'error' not in obj:
self._update_state({'Projects': [obj]})
return [o for o in self.state['Projects']
if o['id'] == obj['id']][0]
return None
def get_item(self, item_id):
"""
Gets an existing item.
"""
params = {'token': self.token,
'item_id': item_id}
data = self._get('get_item', params=params)
obj = data.get('item', None)
if obj and 'error' not in obj:
self._update_state({'Items': [obj]})
return [o for o in self.state['Items'] if o['id'] == obj['id']][0]
return None
def get_label(self, label_id):
"""
Gets an existing label.
"""
params = {'token': self.token,
'label_id': label_id}
data = self._get('get_label', params=params)
obj = data.get('label', None)
if obj and 'error' not in obj:
self._update_state({'Labels': [obj]})
return [o for o in self.state['Labels'] if o['id'] == obj['id']][0]
return None
def get_note(self, note_id):
"""
Gets an existing note.
"""
params = {'token': self.token,
'note_id': note_id}
data = self._get('get_note', params=params)
obj = data.get('note', None)
if obj and 'error' not in obj:
self._update_state({'Notes': [obj]})
return [o for o in self.state['Notes'] if o['id'] == obj['id']][0]
return None
def get_filter(self, filter_id):
"""
Gets an existing filter.
"""
params = {'token': self.token,
'filter_id': filter_id}
data = self._get('get_filter', params=params)
obj = data.get('filter', None)
if obj and 'error' not in obj:
self._update_state({'Filters': [obj]})
return [o for o in self.state['Filters']
if o['id'] == obj['id']][0]
return None
def get_reminder(self, reminder_id):
"""
Gets an existing reminder.
"""
params = {'token': self.token,
'reminder_id': reminder_id}
data = self._get('get_reminder', params=params)
obj = data.get('reminder', None)
if obj and 'error' not in obj:
self._update_state({'Reminders': [obj]})
return [o for o in self.state['Reminders']
if o['id'] == obj['id']][0]
return None
# Class
def __repr__(self):
name = self.__class__.__name__
unsaved = '*' if len(self.queue) > 0 else ''
email = self.user.get('email')
email_repr = repr(email) if email else '<not synchronized>'
return '%s%s(%s)' % (name, unsaved, email_repr)
class TodoistAPI(object):
"""
Implements the API that makes it possible to interact with a Todoist user
account and its data.
"""
_serialize_fields = ('token', 'api_endpoint', 'sync_token', 'state', 'temp_ids')
@classmethod
def deserialize(cls, data):
obj = cls()
for key in cls._serialize_fields:
if key in data:
setattr(obj, key, data[key])
return obj
def __init__(self, token='', api_endpoint='https://api.todoist.com', session=None):
self.api_endpoint = api_endpoint
self.reset_state()
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session() # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
def reset_state(self):
self.sync_token = '*'
self.state = { # Local copy of all of the user's objects
'collaborator_states': [],
'collaborators': [],
'day_orders': {},
'day_orders_timestamp': '',
'filters': [],
'items': [],
'labels': [],
'live_notifications': [],
'live_notifications_last_read_id': -1,
'locations': [],
'notes': [],
'project_notes': [],
'projects': [],
'reminders': [],
'settings': {},
'settings_notifications': {},
'user': {},
'web_static_version': -1,
}
def __getitem__(self, key):
return self.state[key]
def serialize(self):
return {key: getattr(self, key) for key in self._serialize_fields}
def get_api_url(self):
return '%s/API/v7/' % self.api_endpoint
def _update_state(self, syncdata):
"""
Updates the local state, with the data returned by the server after a
sync.
"""
# Check sync token first
self.sync_token = syncdata['sync_token']
# It is straightforward to update these type of data, since it is
# enough to just see if they are present in the sync data, and then
# either replace the local values or update them.
if 'collaborators' in syncdata:
self.state['collaborators'] = syncdata['collaborators']
if 'collaborator_states' in syncdata:
self.state['collaborator_states'] = syncdata['collaborator_states']
if 'day_orders' in syncdata:
self.state['day_orders'].update(syncdata['day_orders'])
if 'day_orders_timestamp' in syncdata:
self.state['day_orders_timestamp'] = syncdata['day_orders_timestamp']
if 'live_notifications_last_read_id' in syncdata:
self.state['live_notifications_last_read_id'] = \
syncdata['live_notifications_last_read_id']
if 'locations' in syncdata:
self.state['locations'] = syncdata['locations']
if 'settings' in syncdata:
self.state['settings'].update(syncdata['settings'])
if 'settings_notifications' in syncdata:
self.state['settings_notifications'].\
update(syncdata['settings_notifications'])
if 'user' in syncdata:
self.state['user'].update(syncdata['user'])
if 'web_static_version' in syncdata:
self.state['web_static_version'] = syncdata['web_static_version']
# Updating these type of data is a bit more complicated, since it is
# necessary to find out whether an object in the sync data is new,
# updates an existing object, or marks an object to be deleted. But
# the same procedure takes place for each of these types of data.
resp_models_mapping = [
('filters', models.Filter),
('items', models.Item),
('labels', models.Label),
('live_notifications', models.LiveNotification),
('notes', models.Note),
('project_notes', models.ProjectNote),
('projects', models.Project),
('reminders', models.Reminder),
]
for datatype, model in resp_models_mapping:
if datatype not in syncdata:
continue
# Process each object of this specific type in the sync data.
for remoteobj in syncdata[datatype]:
# Find out whether the object already exists in the local
# state.
localobj = self._find_object(datatype, remoteobj)
if localobj is not None:
# If the object is already present in the local state, then
# we either update it, or if marked as to be deleted, we
# remove it.
if remoteobj.get('is_deleted', 0) == 0:
localobj.data.update(remoteobj)
else:
self.state[datatype].remove(localobj)
else:
# If not, then the object is new and it should be added,
# unless it is marked as to be deleted (in which case it's
# ignored).
if remoteobj.get('is_deleted', 0) == 0:
newobj = model(remoteobj, self)
self.state[datatype].append(newobj)
def _find_object(self, objtype, obj):
"""
Searches for an object in the local state, depending on the type of
object, and then on its primary key is. If the object is found it is
returned, and if not, then None is returned.
"""
if objtype == 'collaborators':
return self.collaborators.get_by_id(obj['id'])
elif objtype == 'collaborator_states':
return self.collaborator_states.get_by_ids(obj['project_id'],
obj['user_id'])
elif objtype == 'filters':
return self.filters.get_by_id(obj['id'], only_local=True)
elif objtype == 'items':
return self.items.get_by_id(obj['id'], only_local=True)
elif objtype == 'labels':
return self.labels.get_by_id(obj['id'], only_local=True)
elif objtype == 'live_notifications':
return self.live_notifications.get_by_key(obj['notification_key'])
elif objtype == 'notes':
return self.notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'project_notes':
return self.project_notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'projects':
return self.projects.get_by_id(obj['id'], only_local=True)
elif objtype == 'reminders':
return self.reminders.get_by_id(obj['id'], only_local=True)
else:
return None
def _replace_temp_id(self, temp_id, new_id):
"""
Replaces the temporary id generated locally when an object was first
created, with a real Id supplied by the server. True is returned if
the temporary id was found and replaced, and False otherwise.
"""
# Go through all the objects for which we expect the temporary id to be
# replaced by a real one.
for datatype in ['filters', 'items', 'labels', 'notes', 'project_notes',
'projects', 'reminders']:
for obj in self.state[datatype]:
if obj.temp_id == temp_id:
obj['id'] = new_id
return True
return False
def _get(self, call, url=None, **kwargs):
"""
Sends an HTTP GET request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.get(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _post(self, call, url=None, **kwargs):
"""
Sends an HTTP POST request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.post(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
# Sync
def generate_uuid(self):
"""
Generates a uuid.
"""
return str(uuid.uuid1())
def sync(self, commands=None):
"""
Sends to the server the changes that were made locally, and also
fetches the latest updated data from the server.
"""
post_data = {
'token': self.token,
'sync_token': self.sync_token,
'day_orders_timestamp': self.state['day_orders_timestamp'],
'include_notification_settings': 1,
'resource_types': json_dumps(['all']),
'commands': json_dumps(commands or []),
}
response = self._post('sync', data=post_data)
if 'temp_id_mapping' in response:
for temp_id, new_id in response['temp_id_mapping'].items():
self.temp_ids[temp_id] = new_id
self._replace_temp_id(temp_id, new_id)
self._update_state(response)
return response
def commit(self, raise_on_error=True):
"""
Commits all requests that are queued. Note that, without calling this
method none of the changes that are made to the objects are actually
synchronized to the server, unless one of the aforementioned Sync API
calls are called directly.
"""
if len(self.queue) == 0:
return
ret = self.sync(commands=self.queue)
del self.queue[:]
if 'sync_status' in ret:
if raise_on_error:
for k, v in ret['sync_status'].items():
if v != 'ok':
raise SyncError(k, v)
return ret
# Authentication
def login(self, email, password):
"""
Logins user, and returns the response received by the server.
"""
data = self._post('login', data={'email': email,
'password': password})
if 'token' in data:
self.token = data['token']
return data
def login_with_google(self, email, oauth2_token, **kwargs):
"""
Logins user with Google account, and returns the response received by
the server.
"""
data = {'email': email, 'oauth2_token': oauth2_token}
data.update(kwargs)
data = self._post('login_with_google', data=data)
if 'token' in data:
self.token = data['token']
return data
# User
def register(self, email, full_name, password, **kwargs):
"""
Registers a new user.
"""
data = {'email': email, 'full_name': full_name, 'password': password}
data.update(kwargs)
data = self._post('register', data=data)
if 'token' in data:
self.token = data['token']
return data
def delete_user(self, current_password, **kwargs):
"""
Deletes an existing user.
"""
params = {'token': self.token,
'current_password': current_password}
params.update(kwargs)
return self._get('delete_user', params=params)
# Miscellaneous
def upload_file(self, filename, **kwargs):
"""
Uploads a file.
"""
data = {'token': self.token}
data.update(kwargs)
files = {'file': open(filename, 'rb')}
return self._post('upload_file', self.get_api_url(), data=data,
files=files)
def query(self, queries, **kwargs):
"""
Performs date queries and other searches, and returns the results.
"""
params = {'queries': json_dumps(queries),
'token': self.token}
params.update(kwargs)
return self._get('query', params=params)
def get_redirect_link(self, **kwargs):
"""
Returns the absolute URL to redirect or to open in a browser.
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('get_redirect_link', params=params)
def get_productivity_stats(self):
"""
Returns the user's recent productivity stats.
"""
return self._get('get_productivity_stats',
params={'token': self.token})
def update_notification_setting(self, notification_type, service,
dont_notify):
"""
Updates the user's notification settings.
"""
return self._post('update_notification_setting',
data={'token': self.token,
'notification_type': notification_type,
'service': service,
'dont_notify': dont_notify})
def get_all_completed_items(self, **kwargs):
"""
Returns all user's completed items.
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('get_all_completed_items', params=params)
def get_completed_items(self, project_id, **kwargs):
"""
Returns a project's completed items.
"""
params = {'token': self.token,
'project_id': project_id}
params.update(kwargs)
return self._get('get_completed_items', params=params)
def get_uploads(self, **kwargs):
"""
Returns all user's uploads.
kwargs:
limit: (int, optional) number of results (1-50)
last_id: (int, optional) return results with id<last_id
"""
params = {'token': self.token}
params.update(kwargs)
return self._get('uploads/get', params=params)
def delete_upload(self, file_url):
"""
Delete upload.
param file_url: (str) uploaded file URL
"""
params = {'token': self.token, 'file_url': file_url}
return self._get('uploads/delete', params=params)
def add_item(self, content, **kwargs):
"""
Adds a new task.
"""
params = {'token': self.token,
'content': content}
params.update(kwargs)
return self._get('add_item', params=params)
# Sharing
def share_project(self, project_id, email, message='', **kwargs):
"""
Appends a request to the queue, to share a project with a user.
"""
cmd = {
'type': 'share_project',
'temp_id': self.generate_uuid(),
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
'email': email,
},
}
cmd['args'].update(kwargs)
self.queue.append(cmd)
def delete_collaborator(self, project_id, email):
"""
Appends a request to the queue, to delete a collaborator from a shared
project.
"""
cmd = {
'type': 'delete_collaborator',
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
'email': email,
},
}
self.queue.append(cmd)
def take_ownership(self, project_id):
"""
Appends a request to the queue, take ownership of a shared project.
"""
cmd = {
'type': 'take_ownership',
'uuid': self.generate_uuid(),
'args': {
'project_id': project_id,
},
}
self.queue.append(cmd)
# Auxiliary
def get_project(self, project_id):
"""
Gets an existing project.
"""
params = {'token': self.token,
'project_id': project_id}
obj = self._get('get_project', params=params)
if obj and 'error' in obj:
return None
data = {'projects': [], 'project_notes': []}
if obj.get('project'):
data['projects'].append(obj.get('project'))
if obj.get('notes'):
data['project_notes'] += obj.get('notes')
self._update_state(data)
return obj
def get_item(self, item_id):
"""
Gets an existing item.
"""
params = {'token': self.token,
'item_id': item_id}
obj = self._get('get_item', params=params)
if obj and 'error' in obj:
return None
data = {'projects': [], 'items': [], 'notes': []}
if obj.get('project'):
data['projects'].append(obj.get('project'))
if obj.get('item'):
data['items'].append(obj.get('item'))
if obj.get('notes'):
data['notes'] += obj.get('notes')
self._update_state(data)
return obj
def get_label(self, label_id):
"""
Gets an existing label.
"""
params = {'token': self.token,
'label_id': label_id}
obj = self._get('get_label', params=params)
if obj and 'error' in obj:
return None
data = {'labels': []}
if obj.get('label'):
data['labels'].append(obj.get('label'))
self._update_state(data)
return obj
def get_note(self, note_id):
"""
Gets an existing note.
"""
params = {'token': self.token,
'note_id': note_id}
obj = self._get('get_note', params=params)
if obj and 'error' in obj:
return None
data = {'notes': []}
if obj.get('note'):
data['notes'].append(obj.get('note'))
self._update_state(data)
return obj
def get_filter(self, filter_id):
"""
Gets an existing filter.
"""
params = {'token': self.token,
'filter_id': filter_id}
obj = self._get('get_filter', params=params)
if obj and 'error' in obj:
return None
data = {'filters': []}
if obj.get('filter'):
data['filters'].append(obj.get('filter'))
self._update_state(data)
return obj
def get_reminder(self, reminder_id):
"""
Gets an existing reminder.
"""
params = {'token': self.token,
'reminder_id': reminder_id}
obj = self._get('get_reminder', params=params)
if obj and 'error' in obj:
return None
data = {'reminders': []}
if obj.get('reminder'):
data['reminders'].append(obj.get('reminder'))
self._update_state(data)
return obj
# Templates
def import_template_into_project(self, project_id, filename, **kwargs):
"""
Imports a template into a project.
"""
data = {'token': self.token,
'project_id': project_id}
data.update(kwargs)
files = {'file': open(filename, 'r')}
return self._post('templates/import_into_project', self.get_api_url(),
data=data, files=files)
def export_template_as_file(self, project_id, **kwargs):
"""
Exports a template as a file.
"""
data = {'token': self.token,
'project_id': project_id}
data.update(kwargs)
return self._post('templates/export_as_file', self.get_api_url(),
data=data)
def export_template_as_url(self, project_id, **kwargs):
"""
Exports a template as a URL.
"""
data = {'token': self.token,
'project_id': project_id}
data.update(kwargs)
return self._post('templates/export_as_url', self.get_api_url(),
data=data)
# Business
def business_users_invite(self, email_list):
"""
Send a business user invitation.
"""
params = {'token': self.token,
'email_list': json.dumps(email_list)}
return self._get('business/users/invite', params=params)
def business_users_accept_invitation(self, id, secret):
"""
Accept a business user invitation.
"""
params = {'token': self.token,
'id': id,
'secret': secret}
return self._get('business/users/accept_invitation', params=params)
def business_users_reject_invitation(self, id, secret):
"""
Reject a business user invitation.
"""
params = {'token': self.token,
'id': id,
'secret': secret}
return self._get('business/users/reject_invitation', params=params)
# Class
def __repr__(self):
name = self.__class__.__name__
unsaved = '*' if len(self.queue) > 0 else ''
email = self.user.get('email')
email_repr = repr(email) if email else '<not synchronized>'
return '%s%s(%s)' % (name, unsaved, email_repr)
class TodoistAPI(object):
"""
Implements the API that makes it possible to interact with a Todoist user
account and its data.
"""
_serialize_fields = ('token', 'api_endpoint', 'sync_token', 'state',
'temp_ids')
@classmethod
def deserialize(cls, data):
obj = cls()
for key in cls._serialize_fields:
if key in data:
setattr(obj, key, data[key])
return obj
def __init__(self,
token='',
api_endpoint='https://todoist.com',
session=None,
cache='~/.todoist-sync/'):
self.api_endpoint = api_endpoint
self.reset_state()
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session(
) # Session instance for requests
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.user_settings = UserSettingsManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
self.completed = CompletedManager(self)
self.uploads = UploadsManager(self)
self.activity = ActivityManager(self)
self.business_users = BusinessUsersManager(self)
self.templates = TemplatesManager(self)
self.backups = BackupsManager(self)
self.quick = QuickManager(self)
self.emails = EmailsManager(self)
if cache: # Read and write user state on local disk cache
self.cache = os.path.expanduser(cache)
self._read_cache()
else:
self.cache = None
def reset_state(self):
self.sync_token = '*'
self.state = { # Local copy of all of the user's objects
'collaborator_states': [],
'collaborators': [],
'day_orders': {},
'day_orders_timestamp': '',
'filters': [],
'items': [],
'labels': [],
'live_notifications': [],
'live_notifications_last_read_id': -1,
'locations': [],
'notes': [],
'project_notes': [],
'projects': [],
'reminders': [],
'settings_notifications': {},
'user': {},
'user_settings': {},
}
def __getitem__(self, key):
return self.state[key]
def serialize(self):
return {key: getattr(self, key) for key in self._serialize_fields}
def get_api_url(self):
return '%s/API/v8/' % self.api_endpoint
def _update_state(self, syncdata):
"""
Updates the local state, with the data returned by the server after a
sync.
"""
# Check sync token first
if 'sync_token' in syncdata:
self.sync_token = syncdata['sync_token']
# It is straightforward to update these type of data, since it is
# enough to just see if they are present in the sync data, and then
# either replace the local values or update them.
if 'day_orders' in syncdata:
self.state['day_orders'].update(syncdata['day_orders'])
if 'day_orders_timestamp' in syncdata:
self.state['day_orders_timestamp'] = syncdata[
'day_orders_timestamp']
if 'live_notifications_last_read_id' in syncdata:
self.state['live_notifications_last_read_id'] = syncdata[
'live_notifications_last_read_id']
if 'locations' in syncdata:
self.state['locations'] = syncdata['locations']
if 'settings_notifications' in syncdata:
self.state['settings_notifications'].update(
syncdata['settings_notifications'])
if 'user' in syncdata:
self.state['user'].update(syncdata['user'])
if 'user_settings' in syncdata:
self.state['user_settings'].update(syncdata['user_settings'])
# Updating these type of data is a bit more complicated, since it is
# necessary to find out whether an object in the sync data is new,
# updates an existing object, or marks an object to be deleted. But
# the same procedure takes place for each of these types of data.
resp_models_mapping = [
('collaborators', models.Collaborator),
('collaborator_states', models.CollaboratorState),
('filters', models.Filter),
('items', models.Item),
('labels', models.Label),
('live_notifications', models.LiveNotification),
('notes', models.Note),
('project_notes', models.ProjectNote),
('projects', models.Project),
('reminders', models.Reminder),
]
for datatype, model in resp_models_mapping:
if datatype not in syncdata:
continue
# Process each object of this specific type in the sync data.
for remoteobj in syncdata[datatype]:
# Find out whether the object already exists in the local
# state.
localobj = self._find_object(datatype, remoteobj)
if localobj is not None:
# If the object is already present in the local state, then
# we either update it, or if marked as to be deleted, we
# remove it.
is_deleted = remoteobj.get('is_deleted', 0)
if is_deleted == 0 or is_deleted is False:
localobj.data.update(remoteobj)
else:
self.state[datatype].remove(localobj)
else:
# If not, then the object is new and it should be added,
# unless it is marked as to be deleted (in which case it's
# ignored).
is_deleted = remoteobj.get('is_deleted', 0)
if is_deleted == 0 or is_deleted is False:
newobj = model(remoteobj, self)
self.state[datatype].append(newobj)
def _read_cache(self):
if not self.cache:
return
try:
os.makedirs(self.cache)
except OSError:
if not os.path.isdir(self.cache):
raise
try:
with open(self.cache + self.token + '.json') as f:
state = f.read()
state = json.loads(state)
self._update_state(state)
with open(self.cache + self.token + '.sync') as f:
sync_token = f.read()
self.sync_token = sync_token
except:
return
def _write_cache(self):
if not self.cache:
return
result = json.dumps(
self.state, indent=2, sort_keys=True, default=state_default)
with open(self.cache + self.token + '.json', 'w') as f:
f.write(result)
with open(self.cache + self.token + '.sync', 'w') as f:
f.write(self.sync_token)
def _find_object(self, objtype, obj):
"""
Searches for an object in the local state, depending on the type of
object, and then on its primary key is. If the object is found it is
returned, and if not, then None is returned.
"""
if objtype == 'collaborators':
return self.collaborators.get_by_id(obj['id'])
elif objtype == 'collaborator_states':
return self.collaborator_states.get_by_ids(obj['project_id'],
obj['user_id'])
elif objtype == 'filters':
return self.filters.get_by_id(obj['id'], only_local=True)
elif objtype == 'items':
return self.items.get_by_id(obj['id'], only_local=True)
elif objtype == 'labels':
return self.labels.get_by_id(obj['id'], only_local=True)
elif objtype == 'live_notifications':
return self.live_notifications.get_by_id(obj['id'])
elif objtype == 'notes':
return self.notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'project_notes':
return self.project_notes.get_by_id(obj['id'], only_local=True)
elif objtype == 'projects':
return self.projects.get_by_id(obj['id'], only_local=True)
elif objtype == 'reminders':
return self.reminders.get_by_id(obj['id'], only_local=True)
else:
return None
def _replace_temp_id(self, temp_id, new_id):
"""
Replaces the temporary id generated locally when an object was first
created, with a real Id supplied by the server. True is returned if
the temporary id was found and replaced, and False otherwise.
"""
# Go through all the objects for which we expect the temporary id to be
# replaced by a real one.
for datatype in [
'filters', 'items', 'labels', 'notes', 'project_notes',
'projects', 'reminders'
]:
for obj in self.state[datatype]:
if obj.temp_id == temp_id:
obj['id'] = new_id
return True
return False
def _get(self, call, url=None, **kwargs):
"""
Sends an HTTP GET request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.get(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _post(self, call, url=None, **kwargs):
"""
Sends an HTTP POST request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.post(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
# Sync
def generate_uuid(self):
"""
Generates a uuid.
"""
return str(uuid.uuid1())
def sync(self, commands=None):
"""
Sends to the server the changes that were made locally, and also
fetches the latest updated data from the server.
"""
post_data = {
'token': self.token,
'sync_token': self.sync_token,
'day_orders_timestamp': self.state['day_orders_timestamp'],
'include_notification_settings': 1,
'resource_types': json_dumps(['all']),
'commands': json_dumps(commands or []),
}
response = self._post('sync', data=post_data)
if 'temp_id_mapping' in response:
for temp_id, new_id in response['temp_id_mapping'].items():
self.temp_ids[temp_id] = new_id
self._replace_temp_id(temp_id, new_id)
self._update_state(response)
self._write_cache()
return response
def commit(self, raise_on_error=True):
"""
Commits all requests that are queued. Note that, without calling this
method none of the changes that are made to the objects are actually
synchronized to the server, unless one of the aforementioned Sync API
calls are called directly.
"""
if len(self.queue) == 0:
return
ret = self.sync(commands=self.queue)
del self.queue[:]
if 'sync_status' in ret:
if raise_on_error:
for k, v in ret['sync_status'].items():
if v != 'ok':
raise SyncError(k, v)
return ret
# Miscellaneous
def query(self, queries, **kwargs):
"""
DEPRECATED: query endpoint is deprecated for a long time and this
method will be removed in the next major version of todoist-python
"""
params = {'queries': json_dumps(queries), 'token': self.token}
params.update(kwargs)
return self._get('query', params=params)
def add_item(self, content, **kwargs):
"""
Adds a new task.
"""
params = {'token': self.token, 'content': content}
params.update(kwargs)
if 'labels' in params:
params['labels'] = str(params['labels'])
return self._get('add_item', params=params)
# Class
def __repr__(self):
name = self.__class__.__name__
unsaved = '*' if len(self.queue) > 0 else ''
email = self.user.get('email')
email_repr = repr(email) if email else '<not synchronized>'
return '%s%s(%s)' % (name, unsaved, email_repr)
class TodoistAPI(object):
"""
Implements the API that makes it possible to interact with a Todoist user
account and its data.
"""
_serialize_fields = ("token", "api_endpoint", "sync_token", "state",
"temp_ids")
@classmethod
def deserialize(cls, data):
obj = cls()
for key in cls._serialize_fields:
if key in data:
setattr(obj, key, data[key])
return obj
def __init__(
self,
token="",
api_endpoint="https://api.todoist.com",
api_version=DEFAULT_API_VERSION,
session=None,
cache="~/.todoist-sync/",
):
self.api_endpoint = api_endpoint
self.api_version = api_version
self.reset_state()
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
self.session = session or requests.Session(
) # Session instance for requests
# managers
self.biz_invitations = BizInvitationsManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
self.filters = FiltersManager(self)
self.invitations = InvitationsManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.locations = LocationsManager(self)
self.notes = NotesManager(self)
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.reminders = RemindersManager(self)
self.sections = SectionsManager(self)
self.user = UserManager(self)
self.user_settings = UserSettingsManager(self)
self.activity = ActivityManager(self)
self.backups = BackupsManager(self)
self.business_users = BusinessUsersManager(self)
self.completed = CompletedManager(self)
self.emails = EmailsManager(self)
self.quick = QuickManager(self)
self.templates = TemplatesManager(self)
self.uploads = UploadsManager(self)
self.items_archive = ItemsArchiveManagerMaker(self)
self.sections_archive = SectionsArchiveManagerMaker(self)
if cache: # Read and write user state on local disk cache
self.cache = os.path.expanduser(cache)
self._read_cache()
else:
self.cache = None
def reset_state(self):
self.sync_token = "*"
self.state = { # Local copy of all of the user's objects
"collaborator_states": [],
"collaborators": [],
"day_orders": {},
"day_orders_timestamp": "",
"filters": [],
"items": [],
"labels": [],
"live_notifications": [],
"live_notifications_last_read_id": -1,
"locations": [],
"notes": [],
"project_notes": [],
"projects": [],
"reminders": [],
"sections": [],
"settings_notifications": {},
"user": {},
"user_settings": {},
}
def __getitem__(self, key):
return self.state[key]
def serialize(self):
return {key: getattr(self, key) for key in self._serialize_fields}
def get_api_url(self):
return "{0}/sync/{1}/".format(self.api_endpoint, self.api_version)
def _update_state(self, syncdata):
"""
Updates the local state, with the data returned by the server after a
sync.
"""
# Check sync token first
if "sync_token" in syncdata:
self.sync_token = syncdata["sync_token"]
# It is straightforward to update these type of data, since it is
# enough to just see if they are present in the sync data, and then
# either replace the local values or update them.
if "day_orders" in syncdata:
self.state["day_orders"].update(syncdata["day_orders"])
if "day_orders_timestamp" in syncdata:
self.state["day_orders_timestamp"] = syncdata[
"day_orders_timestamp"]
if "live_notifications_last_read_id" in syncdata:
self.state["live_notifications_last_read_id"] = syncdata[
"live_notifications_last_read_id"]
if "locations" in syncdata:
self.state["locations"] = syncdata["locations"]
if "settings_notifications" in syncdata:
self.state["settings_notifications"].update(
syncdata["settings_notifications"])
if "user" in syncdata:
self.state["user"].update(syncdata["user"])
if "user_settings" in syncdata:
self.state["user_settings"].update(syncdata["user_settings"])
# Updating these type of data is a bit more complicated, since it is
# necessary to find out whether an object in the sync data is new,
# updates an existing object, or marks an object to be deleted. But
# the same procedure takes place for each of these types of data.
resp_models_mapping = [
("collaborators", models.Collaborator),
("collaborator_states", models.CollaboratorState),
("filters", models.Filter),
("items", models.Item),
("labels", models.Label),
("live_notifications", models.LiveNotification),
("notes", models.Note),
("project_notes", models.ProjectNote),
("projects", models.Project),
("reminders", models.Reminder),
("sections", models.Section),
]
for datatype, model in resp_models_mapping:
if datatype not in syncdata:
continue
# Process each object of this specific type in the sync data.
for remoteobj in syncdata[datatype]:
# Find out whether the object already exists in the local
# state.
localobj = self._find_object(datatype, remoteobj)
if localobj is not None:
# If the object is already present in the local state, then
# we either update it, or if marked as to be deleted, we
# remove it.
is_deleted = remoteobj.get("is_deleted", 0)
if is_deleted == 0 or is_deleted is False:
localobj.data.update(remoteobj)
else:
self.state[datatype].remove(localobj)
else:
# If not, then the object is new and it should be added,
# unless it is marked as to be deleted (in which case it's
# ignored).
is_deleted = remoteobj.get("is_deleted", 0)
if is_deleted == 0 or is_deleted is False:
newobj = model(remoteobj, self)
self.state[datatype].append(newobj)
def _read_cache(self):
if not self.cache:
return
try:
os.makedirs(self.cache)
except OSError:
if not os.path.isdir(self.cache):
raise
try:
with open(self.cache + self.token + ".json") as f:
state = f.read()
state = json.loads(state)
self._update_state(state)
with open(self.cache + self.token + ".sync") as f:
sync_token = f.read()
self.sync_token = sync_token
except Exception:
return
def _write_cache(self):
if not self.cache:
return
result = json.dumps(self.state,
indent=2,
sort_keys=True,
default=state_default)
with open(self.cache + self.token + ".json", "w") as f:
f.write(result)
with open(self.cache + self.token + ".sync", "w") as f:
f.write(self.sync_token)
def _find_object(self, objtype, obj):
"""
Searches for an object in the local state, depending on the type of
object, and then on its primary key is. If the object is found it is
returned, and if not, then None is returned.
"""
if objtype == "collaborators":
return self.collaborators.get_by_id(obj["id"])
elif objtype == "collaborator_states":
return self.collaborator_states.get_by_ids(obj["project_id"],
obj["user_id"])
elif objtype == "filters":
return self.filters.get_by_id(obj["id"], only_local=True)
elif objtype == "items":
return self.items.get_by_id(obj["id"], only_local=True)
elif objtype == "labels":
return self.labels.get_by_id(obj["id"], only_local=True)
elif objtype == "live_notifications":
return self.live_notifications.get_by_id(obj["id"])
elif objtype == "notes":
return self.notes.get_by_id(obj["id"], only_local=True)
elif objtype == "project_notes":
return self.project_notes.get_by_id(obj["id"], only_local=True)
elif objtype == "projects":
return self.projects.get_by_id(obj["id"], only_local=True)
elif objtype == "reminders":
return self.reminders.get_by_id(obj["id"], only_local=True)
elif objtype == "sections":
return self.sections.get_by_id(obj["id"], only_local=True)
else:
return None
def _replace_temp_id(self, temp_id, new_id):
"""
Replaces the temporary id generated locally when an object was first
created, with a real Id supplied by the server. True is returned if
the temporary id was found and replaced, and False otherwise.
"""
# Go through all the objects for which we expect the temporary id to be
# replaced by a real one.
for datatype in [
"filters",
"items",
"labels",
"notes",
"project_notes",
"projects",
"reminders",
"sections",
]:
for obj in self.state[datatype]:
if obj.temp_id == temp_id:
obj["id"] = new_id
return True
return False
def _get(self, call, url=None, **kwargs):
"""
Sends an HTTP GET request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.get(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _post(self, call, url=None, **kwargs):
"""
Sends an HTTP POST request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = self.session.post(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
# Sync
def generate_uuid(self):
"""
Generates a uuid.
"""
return str(uuid.uuid1())
def sync(self, commands=None):
"""
Sends to the server the changes that were made locally, and also
fetches the latest updated data from the server.
"""
post_data = {
"token": self.token,
"sync_token": self.sync_token,
"day_orders_timestamp": self.state["day_orders_timestamp"],
"include_notification_settings": 1,
"resource_types": json_dumps(["all"]),
"commands": json_dumps(commands or []),
}
response = self._post("sync", data=post_data)
if "temp_id_mapping" in response:
for temp_id, new_id in response["temp_id_mapping"].items():
self.temp_ids[temp_id] = new_id
self._replace_temp_id(temp_id, new_id)
self._update_state(response)
self._write_cache()
return response
def commit(self, raise_on_error=True):
"""
Commits all requests that are queued. Note that, without calling this
method none of the changes that are made to the objects are actually
synchronized to the server, unless one of the aforementioned Sync API
calls are called directly.
"""
if len(self.queue) == 0:
return
ret = self.sync(commands=self.queue)
del self.queue[:]
if "sync_status" in ret:
if raise_on_error:
for k, v in ret["sync_status"].items():
if v != "ok":
raise SyncError(k, v)
return ret
# Miscellaneous
def query(self, queries, **kwargs):
"""
DEPRECATED: query endpoint is deprecated for a long time and this
method will be removed in the next major version of todoist-python
"""
params = {"queries": json_dumps(queries), "token": self.token}
params.update(kwargs)
return self._get("query", params=params)
def add_item(self, content, **kwargs):
"""
Adds a new task.
"""
params = {"token": self.token, "content": content}
params.update(kwargs)
if "labels" in params:
params["labels"] = str(params["labels"])
return self._get("add_item", params=params)
# Class
def __repr__(self):
name = self.__class__.__name__
unsaved = "*" if len(self.queue) > 0 else ""
email = self.user.get("email")
email_repr = repr(email) if email else "<not synchronized>"
return "%s%s(%s)" % (name, unsaved, email_repr)
class TodoistAPI(object):
"""
Implements the API that makes it possible to interact with a Todoist user
account and its data.
"""
_serialize_fields = (
"token",
"api_endpoint",
"seq_no",
"seq_no_partial",
"seq_no_global",
"seq_no_global_partial",
"state",
"temp_ids",
)
@classmethod
def deserialize(cls, data):
obj = cls()
for key in cls._serialize_fields:
if key in data:
setattr(obj, key, data[key])
return obj
def __init__(self, token="", api_endpoint="https://api.todoist.com"):
self.api_endpoint = api_endpoint
self.seq_no = 0 # Sequence number since last update
self.seq_no_partial = {} # Sequence number of partial syncs
self.seq_no_global = 0 # Global sequence number since last update
self.seq_no_global_partial = {} # Global sequence number of partial syncs
self.state = { # Local copy of all of the user's objects
"CollaboratorStates": [],
"Collaborators": [],
"DayOrders": {},
"DayOrdersTimestamp": "",
"Filters": [],
"Items": [],
"Labels": [],
"LiveNotifications": [],
"LiveNotificationsLastRead": -1,
"Locations": [],
"Notes": [],
"ProjectNotes": [],
"Projects": [],
"Reminders": [],
"Settings": {},
"SettingsNotifications": {},
"User": {},
"UserId": -1,
"WebStaticVersion": -1,
}
self.token = token # User's API token
self.temp_ids = {} # Mapping of temporary ids to real ids
self.queue = [] # Requests to be sent are appended here
# managers
self.projects = ProjectsManager(self)
self.project_notes = ProjectNotesManager(self)
self.items = ItemsManager(self)
self.labels = LabelsManager(self)
self.filters = FiltersManager(self)
self.notes = NotesManager(self)
self.live_notifications = LiveNotificationsManager(self)
self.reminders = RemindersManager(self)
self.locations = LocationsManager(self)
self.invitations = InvitationsManager(self)
self.biz_invitations = BizInvitationsManager(self)
self.user = UserManager(self)
self.collaborators = CollaboratorsManager(self)
self.collaborator_states = CollaboratorStatesManager(self)
def __getitem__(self, key):
return self.state[key]
def serialize(self):
return {key: getattr(self, key) for key in self._serialize_fields}
def get_api_url(self):
return "%s/API/v6/" % self.api_endpoint
def _update_state(self, syncdata):
"""
Updates the local state, with the data returned by the server after a
sync.
"""
# It is straightforward to update these type of data, since it is
# enough to just see if they are present in the sync data, and then
# either replace the local values or update them.
if "Collaborators" in syncdata:
self.state["Collaborators"] = syncdata["Collaborators"]
if "CollaboratorStates" in syncdata:
self.state["CollaboratorStates"] = syncdata["CollaboratorStates"]
if "DayOrders" in syncdata:
self.state["DayOrders"].update(syncdata["DayOrders"])
if "DayOrdersTimestamp" in syncdata:
self.state["DayOrdersTimestamp"] = syncdata["DayOrdersTimestamp"]
if "LiveNotificationsLastRead" in syncdata:
self.state["LiveNotificationsLastRead"] = syncdata["LiveNotificationsLastRead"]
if "Locations" in syncdata:
self.state["Locations"] = syncdata["Locations"]
if "Settings" in syncdata:
self.state["Settings"].update(syncdata["Settings"])
if "SettingsNotifications" in syncdata:
self.state["SettingsNotifications"].update(syncdata["SettingsNotifications"])
if "User" in syncdata:
self.state["User"].update(syncdata["User"])
if "UserId" in syncdata:
self.state["UserId"] = syncdata["UserId"]
if "WebStaticVersion" in syncdata:
self.state["WebStaticVersion"] = syncdata["WebStaticVersion"]
# Updating these type of data is a bit more complicated, since it is
# necessary to find out whether an object in the sync data is new,
# updates an existing object, or marks an object to be deleted. But
# the same procedure takes place for each of these types of data.
for datatype in (
"Filters",
"Items",
"Labels",
"LiveNotifications",
"Notes",
"ProjectNotes",
"Projects",
"Reminders",
):
if datatype not in syncdata:
continue
# Process each object of this specific type in the sync data.
for remoteobj in syncdata[datatype]:
# Find out whether the object already exists in the local
# state.
localobj = self._find_object(datatype, remoteobj)
if localobj is not None:
# If the object is already present in the local state, then
# we either update it, or if marked as to be deleted, we
# remove it.
if remoteobj.get("is_deleted", 0) == 0:
localobj.data.update(remoteobj)
else:
self.state[datatype].remove(localobj)
else:
# If not, then the object is new and it should be added,
# unless it is marked as to be deleted (in which case it's
# ignored).
if remoteobj.get("is_deleted", 0) == 0:
model = "models." + datatype[:-1]
newobj = eval(model)(remoteobj, self)
self.state[datatype].append(newobj)
def _find_object(self, objtype, obj):
"""
Searches for an object in the local state, depending on the type of
object, and then on its primary key is. If the object is found it is
returned, and if not, then None is returned.
"""
if objtype == "Collaborators":
return self.collaborators.get_by_id(obj["id"])
elif objtype == "CollaboratorStates":
return self.collaborator_states.get_by_ids(obj["project_id"], obj["user_id"])
elif objtype == "Filters":
return self.filters.get_by_id(obj["id"], only_local=True)
elif objtype == "Items":
return self.items.get_by_id(obj["id"], only_local=True)
elif objtype == "Labels":
return self.labels.get_by_id(obj["id"], only_local=True)
elif objtype == "LiveNotifications":
return self.live_notifications.get_by_key(obj["notification_key"])
elif objtype == "Notes":
return self.notes.get_by_id(obj["id"], only_local=True)
elif objtype == "ProjectNotes":
return self.project_notes.get_by_id(obj["id"], only_local=True)
elif objtype == "Projects":
return self.projects.get_by_id(obj["id"], only_local=True)
elif objtype == "Reminders":
return self.reminders.get_by_id(obj["id"], only_local=True)
else:
return None
def _get_seq_no(self, resource_types):
"""
Calculates what is the seq_no that should be sent, based on the last
seq_no and the resource_types that are requested.
"""
seq_no = -1
seq_no_global = -1
if resource_types:
for resource in resource_types:
if resource not in self.seq_no_partial:
seq_no = self.seq_no
else:
if seq_no == -1 or self.seq_no_partial[resource] < seq_no:
seq_no = self.seq_no_partial[resource]
if resource not in self.seq_no_global_partial:
seq_no_global = self.seq_no_global
else:
if seq_no_global == -1 or self.seq_no_global_partial[resource] < seq_no_global:
seq_no_global = self.seq_no_global_partial[resource]
if seq_no == -1:
seq_no = self.seq_no
if seq_no_global == -1:
seq_no_global = self.seq_no_global
return seq_no, seq_no_global
def _update_seq_no(self, seq_no, seq_no_global, resource_types):
"""
Updates the seq_no and the seq_no_partial, based on the seq_no in
the response and the resource_types that were requested.
"""
if not seq_no and not seq_no_global or not resource_types:
return
if "all" in resource_types:
if seq_no:
self.seq_no = seq_no
self.seq_no_partial = {}
if seq_no_global:
self.seq_no_global = seq_no_global
self.seq_no_global_partial = {}
else:
if seq_no and seq_no > self.seq_no:
for resource in resource_types:
self.seq_no_partial[resource] = seq_no
if seq_no_global and seq_no_global > self.seq_no_global:
for resource in resource_types:
self.seq_no_global_partial[resource] = seq_no_global
def _replace_temp_id(self, temp_id, new_id):
"""
Replaces the temporary id generated locally when an object was first
created, with a real Id supplied by the server. True is returned if
the temporary id was found and replaced, and False otherwise.
"""
# Go through all the objects for which we expect the temporary id to be
# replaced by a real one.
for datatype in ["Filters", "Items", "Labels", "Notes", "ProjectNotes", "Projects", "Reminders"]:
for obj in self.state[datatype]:
if obj.temp_id == temp_id:
obj["id"] = new_id
return True
return False
def _get(self, call, url=None, **kwargs):
"""
Sends an HTTP GET request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = requests.get(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _post(self, call, url=None, **kwargs):
"""
Sends an HTTP POST request to the specified URL, and returns the JSON
object received (if any), or whatever answer it got otherwise.
"""
if not url:
url = self.get_api_url()
response = requests.post(url + call, **kwargs)
try:
return response.json()
except ValueError:
return response.text
def _json_serializer(self, obj):
import datetime
if isinstance(obj, datetime.datetime):
return obj.strftime("%Y-%m-%dT%H:%M:%S")
elif isinstance(obj, datetime.date):
return obj.strftime("%Y-%m-%d")
elif isinstance(obj, datetime.time):
return obj.strftime("%H:%M:%S")
# Sync
def generate_uuid(self):
"""
Generates a uuid.
"""
return str(uuid.uuid1())
def sync(self, commands=None, **kwargs):
"""
Sends to the server the changes that were made locally, and also
fetches the latest updated data from the server.
"""
data = {
"token": self.token,
"commands": json.dumps(commands or [], separators=",:", default=self._json_serializer),
"day_orders_timestamp": self.state["DayOrdersTimestamp"],
}
if not commands:
data["seq_no"], data["seq_no_global"] = self._get_seq_no(kwargs.get("resource_types", None))
if "include_notification_settings" in kwargs:
data["include_notification_settings"] = 1
if "resource_types" in kwargs:
data["resource_types"] = json.dumps(kwargs["resource_types"], separators=",:")
data = self._post("sync", data=data)
self._update_state(data)
if not commands:
self._update_seq_no(
data.get("seq_no", None), data.get("seq_no_global", None), kwargs.get("resource_types", None)
)
return data
def commit(self):
"""
Commits all requests that are queued. Note that, without calling this
method none of the changes that are made to the objects are actually
synchronized to the server, unless one of the aforementioned Sync API
calls are called directly.
"""
if len(self.queue) == 0:
return
ret = self.sync(commands=self.queue)
del self.queue[:]
if "TempIdMapping" in ret:
for temp_id, new_id in ret["TempIdMapping"].items():
self.temp_ids[temp_id] = new_id
self._replace_temp_id(temp_id, new_id)
if "SyncStatus" in ret:
return ret["SyncStatus"]
return ret
# Authentication
def login(self, email, password):
"""
Logins user, and returns the response received by the server.
"""
data = self._post("login", data={"email": email, "password": password})
if "token" in data:
self.token = data["token"]
return data
def login_with_google(self, email, oauth2_token, **kwargs):
"""
Logins user with Google account, and returns the response received by
the server.
"""
data = {"email": email, "oauth2_token": oauth2_token}
data.update(kwargs)
data = self._post("login_with_google", data=data)
if "token" in data:
self.token = data["token"]
return data
# User
def register(self, email, full_name, password, **kwargs):
"""
Registers a new user.
"""
data = {"email": email, "full_name": full_name, "password": password}
data.update(kwargs)
data = self._post("register", data=data)
if "token" in data:
self.token = data["token"]
return data
def delete_user(self, current_password, **kwargs):
"""
Deletes an existing user.
"""
params = {"token": self.token, "current_password": current_password}
params.update(kwargs)
return self._get("delete_user", params=params)
# Miscellaneous
def upload_file(self, filename, **kwargs):
"""
Uploads a file.
"""
data = {"token": self.token}
data.update(kwargs)
files = {"file": open(filename, "rb")}
return self._post("upload_file", self.get_api_url(), data=data, files=files)
def query(self, queries, **kwargs):
"""
Performs date queries and other searches, and returns the results.
"""
params = {"queries": json.dumps(queries, separators=",:", default=self._json_serializer), "token": self.token}
params.update(kwargs)
return self._get("query", params=params)
def get_redirect_link(self, **kwargs):
"""
Returns the absolute URL to redirect or to open in a browser.
"""
params = {"token": self.token}
params.update(kwargs)
return self._get("get_redirect_link", params=params)
def get_productivity_stats(self):
"""
Returns the user's recent productivity stats.
"""
return self._get("get_productivity_stats", params={"token": self.token})
def update_notification_setting(self, notification_type, service, dont_notify):
"""
Updates the user's notification settings.
"""
return self._post(
"update_notification_setting",
data={
"token": self.token,
"notification_type": notification_type,
"service": service,
"dont_notify": dont_notify,
},
)
def get_all_completed_items(self, **kwargs):
"""
Returns all user's completed items.
"""
params = {"token": self.token}
params.update(kwargs)
return self._get("get_all_completed_items", params=params)
def add_item(self, content, **kwargs):
"""
Adds a new task.
"""
params = {"token": self.token, "content": content}
params.update(kwargs)
return self._get("add_item", params=params)
# Sharing
def share_project(self, project_id, email, message="", **kwargs):
"""
Appends a request to the queue, to share a project with a user.
"""
cmd = {
"type": "share_project",
"temp_id": self.generate_uuid(),
"uuid": self.generate_uuid(),
"args": {"project_id": project_id, "email": email},
}
cmd["args"].update(kwargs)
self.queue.append(cmd)
def delete_collaborator(self, project_id, email):
"""
Appends a request to the queue, to delete a collaborator from a shared
project.
"""
cmd = {
"type": "delete_collaborator",
"uuid": self.generate_uuid(),
"args": {"project_id": project_id, "email": email},
}
self.queue.append(cmd)
def take_ownership(self, project_id):
"""
Appends a request to the queue, take ownership of a shared project.
"""
cmd = {"type": "take_ownership", "uuid": self.generate_uuid(), "args": {"project_id": project_id}}
self.queue.append(cmd)
# Auxiliary
def get_project(self, project_id):
"""
Gets an existing project.
"""
params = {"token": self.token, "project_id": project_id}
data = self._get("get_project", params=params)
obj = data.get("project", None)
if obj and "error" not in obj:
self._update_state({"Projects": [obj]})
return [o for o in self.state["Projects"] if o["id"] == obj["id"]][0]
return None
def get_item(self, item_id):
"""
Gets an existing item.
"""
params = {"token": self.token, "item_id": item_id}
data = self._get("get_item", params=params)
obj = data.get("item", None)
if obj and "error" not in obj:
self._update_state({"Items": [obj]})
return [o for o in self.state["Items"] if o["id"] == obj["id"]][0]
return None
def get_label(self, label_id):
"""
Gets an existing label.
"""
params = {"token": self.token, "label_id": label_id}
data = self._get("get_label", params=params)
obj = data.get("label", None)
if obj and "error" not in obj:
self._update_state({"Labels": [obj]})
return [o for o in self.state["Labels"] if o["id"] == obj["id"]][0]
return None
def get_note(self, note_id):
"""
Gets an existing note.
"""
params = {"token": self.token, "note_id": note_id}
data = self._get("get_note", params=params)
obj = data.get("note", None)
if obj and "error" not in obj:
self._update_state({"Notes": [obj]})
return [o for o in self.state["Notes"] if o["id"] == obj["id"]][0]
return None
def get_filter(self, filter_id):
"""
Gets an existing filter.
"""
params = {"token": self.token, "filter_id": filter_id}
data = self._get("get_filter", params=params)
obj = data.get("filter", None)
if obj and "error" not in obj:
self._update_state({"Filters": [obj]})
return [o for o in self.state["Filters"] if o["id"] == obj["id"]][0]
return None
def get_reminder(self, reminder_id):
"""
Gets an existing reminder.
"""
params = {"token": self.token, "reminder_id": reminder_id}
data = self._get("get_reminder", params=params)
obj = data.get("reminder", None)
if obj and "error" not in obj:
self._update_state({"Reminders": [obj]})
return [o for o in self.state["Reminders"] if o["id"] == obj["id"]][0]
return None
# Class
def __repr__(self):
name = self.__class__.__name__
unsaved = "*" if len(self.queue) > 0 else ""
email = self.user.get("email")
email_repr = repr(email) if email else "<not synchronized>"
return "%s%s(%s)" % (name, unsaved, email_repr)
