Merge pull request #48 from ucfopen/develop

Release v0.5.1

Resolves #49

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [0.5.1] - 2017-08-02
+### General
+- Moved documentation to [Read the Docs](http://canvasapi.readthedocs.io).
+
+### Bugfixes
+
+- Fixed an issue where kwargs in Python 2.7 wouldn't be properly formatted when converted to get parameters.
+
 ## [0.5.0] - 2017-07-10
 ### New Endpoint Coverage
 
@@ -99,6 +107,8 @@
 - Fixed some incorrectly defined parameters
 - Fixed an issue where tests would fail due to an improperly configured requires block
 
+[0.5.1]: https://github.com/ucfopen/canvasapi/compare/v0.5.0...v0.5.1
+[0.5.0]: https://github.com/ucfopen/canvasapi/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/ucfopen/canvasapi/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/ucfopen/canvasapi/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/ucfopen/canvasapi/compare/v0.1.2...v0.2.0

canvasapi/__init__.py

@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
 
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 from canvasapi.canvas import Canvas
 
 __all__ = ["Canvas"]
 
-__version__ = '0.5.0'
+__version__ = '0.5.1'

canvasapi/account.py

@@ -1,13 +1,14 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
-from builtins import str
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.exceptions import RequiredFieldMissing
 from canvasapi.paginated_list import PaginatedList
 from canvasapi.util import combine_kwargs, obj_or_id
 
 
+@python_2_unicode_compatible
 class Account(CanvasObject):
 
     def __str__(self):
@@ -920,25 +921,29 @@ def update_account_auth_settings(self, **kwargs):
         return SSOSettings(self._requester, response.json())
 
 
+@python_2_unicode_compatible
 class AccountNotification(CanvasObject):
 
     def __str__(self):  # pragma: no cover
-        return str(self.subject)
+        return "{}".format(self.subject)
 
 
+@python_2_unicode_compatible
 class AccountReport(CanvasObject):
 
     def __str__(self):  # pragma: no cover
         return "{} ({})".format(self.report, self.id)
 
 
+@python_2_unicode_compatible
 class Role(CanvasObject):
 
     def __str__(self):  # pragma: no cover
         return "{} ({})".format(self.label, self.base_role_type)
 
 
+@python_2_unicode_compatible
 class SSOSettings(CanvasObject):
 
-    def __str___(self):  # pragma: no cover
+    def __str__(self):  # pragma: no cover
         return"{} ({})".format(self.login_handle_name, self.change_password_url)

canvasapi/appointment_group.py

@@ -1,12 +1,18 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.exceptions import RequiredFieldMissing
 from canvasapi.util import combine_kwargs
 
 
+@python_2_unicode_compatible
 class AppointmentGroup(CanvasObject):
 
+    def __str__(self):
+        return "{} ({})".format(self.title, self.id)
+
     def delete(self, **kwargs):
         """
         Delete this appointment group.
@@ -49,6 +55,3 @@ def edit(self, appointment_group, **kwargs):
             super(AppointmentGroup, self).set_attributes(response.json())
 
         return AppointmentGroup(self._requester, response.json())
-
-    def __str__(self):
-        return "{} ({})".format(self.title, self.id)

canvasapi/assignment.py

@@ -1,9 +1,12 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.util import combine_kwargs
 
 
+@python_2_unicode_compatible
 class Assignment(CanvasObject):
 
     def __str__(self):
@@ -45,6 +48,7 @@ def edit(self, **kwargs):
         return Assignment(self._requester, response.json())
 
 
+@python_2_unicode_compatible
 class AssignmentGroup(CanvasObject):
 
     def __str__(self):

canvasapi/authentication_provider.py

@@ -1,9 +1,12 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.util import combine_kwargs
 
 
+@python_2_unicode_compatible
 class AuthenticationProvider(CanvasObject):
 
     def __str__(self):  # pragma: no cover

canvasapi/avatar.py

@@ -1,11 +1,12 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
-from builtins import str
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 
 
+@python_2_unicode_compatible
 class Avatar(CanvasObject):
 
     def __str__(self):  # pragma: no cover
-        return str(self.display_name)
+        return "{}".format(self.display_name)

canvasapi/bookmark.py

@@ -1,11 +1,17 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.util import combine_kwargs
 
 
+@python_2_unicode_compatible
 class Bookmark(CanvasObject):
 
+    def __str__(self):
+        return "{} ({})".format(self.name, self.id)
+
     def delete(self):
         """
         Delete this bookmark.
@@ -40,6 +46,3 @@ def edit(self, **kwargs):
             super(Bookmark, self).set_attributes(response.json())
 
         return Bookmark(self._requester, response.json())
-
-    def __str__(self):
-        return "{} ({})".format(self.name, self.id)

canvasapi/calendar_event.py

@@ -1,11 +1,14 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.util import combine_kwargs
 
 
 class CalendarEvent(CanvasObject):
 
+    def __str__(self):
+        return "{} ({})".format(self.title, self.id)
+
     def delete(self, **kwargs):
         """
         Delete this calendar event.
@@ -41,6 +44,3 @@ def edit(self, **kwargs):
             super(CalendarEvent, self).set_attributes(response.json())
 
         return CalendarEvent(self._requester, response.json())
-
-    def __str__(self):
-        return "{} ({})".format(self.title, self.id)

canvasapi/canvas.py

@@ -1,6 +1,4 @@
-from __future__ import unicode_literals
-
-from builtins import object
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 from canvasapi.account import Account
 from canvasapi.course import Course

canvasapi/canvas_object.py

@@ -1,9 +1,9 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 from datetime import datetime
 import json
 import re
 
-from builtins import str, object
+from six import text_type
 
 DATE_PATTERN = re.compile('[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z')
 
@@ -68,6 +68,6 @@ def set_attributes(self, attributes):
             self.__setattr__(attribute, value)
 
             # datetime field
-            if DATE_PATTERN.match(str(value)):
+            if DATE_PATTERN.match(text_type(value)):
                 date = datetime.strptime(value, '%Y-%m-%dT%H:%M:%SZ')
                 self.__setattr__(attribute + '_date', date)

canvasapi/communication_channel.py

@@ -1,9 +1,12 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.notification_preference import NotificationPreference
 
 
+@python_2_unicode_compatible
 class CommunicationChannel(CanvasObject):
 
     def __str__(self):

canvasapi/conversation.py

@@ -1,9 +1,12 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.util import combine_kwargs
 
 
+@python_2_unicode_compatible
 class Conversation(CanvasObject):
 
     def __str__(self):

canvasapi/course.py

@@ -1,4 +1,6 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.discussion_topic import DiscussionTopic
@@ -13,6 +15,7 @@
 from canvasapi.util import combine_kwargs
 
 
+@python_2_unicode_compatible
 class Course(CanvasObject):
 
     def __str__(self):
@@ -1409,6 +1412,7 @@ def update_tab(self, tab_id, **kwargs):
         return Tab(self._requester, response.json())
 
 
+@python_2_unicode_compatible
 class CourseNickname(CanvasObject):
 
     def __str__(self):

canvasapi/discussion_topic.py

@@ -1,10 +1,13 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.paginated_list import PaginatedList
 from canvasapi.util import combine_kwargs
 
 
+@python_2_unicode_compatible
 class DiscussionTopic(CanvasObject):
     def __str__(self):
         return "{} ({})".format(self.title, self.id)

canvasapi/enrollment.py

@@ -1,8 +1,11 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 
 
+@python_2_unicode_compatible
 class Enrollment(CanvasObject):
 
     def __str__(self):

canvasapi/enrollment_term.py

@@ -1,11 +1,17 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 from canvasapi.util import combine_kwargs
 
 
+@python_2_unicode_compatible
 class EnrollmentTerm(CanvasObject):
 
+    def __str__(self):
+        return "{} ({})".format(self.name, self.id)
+
     def delete(self):
         """
         Delete this Enrollment Term.
@@ -37,6 +43,3 @@ def edit(self, **kwargs):
         )
 
         return EnrollmentTerm(self._requester, response.json())
-
-    def __str__(self):
-        return "{} ({})".format(self.name, self.id)

canvasapi/exceptions.py

@@ -1,8 +1,9 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
-from builtins import str
+from six import python_2_unicode_compatible, text_type
 
 
+@python_2_unicode_compatible
 class CanvasException(Exception):  # pragma: no cover
     """
     Base class for all errors returned by the Canvas API.
@@ -13,14 +14,14 @@ def __init__(self, message):
 
             errors = message.get('errors', False)
             if errors:
-                self.message = str(errors)
+                self.message = errors
             else:
                 self.message = ('Something went wrong. ', message)
         else:
             self.message = message
 
     def __str__(self):
-        return self.message
+        return text_type(self.message)
 
 
 class BadRequest(CanvasException):

canvasapi/external_feed.py

@@ -1,11 +1,12 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
-from builtins import str
+from six import python_2_unicode_compatible
 
 from canvasapi.canvas_object import CanvasObject
 
 
+@python_2_unicode_compatible
 class ExternalFeed(CanvasObject):
 
     def __str__(self):
-        return str(self.display_name)
+        return "{}".format(self.display_name)