Merge pull request #101 from stopic13/master

Adding python 3 support

Author: brianjmiller

.travis.yml

@@ -1,8 +1,8 @@
 language: python
 python:
-  - "2.7"
-install: easy_install aniso8601 pytz
+  - "3.6"
+install: pip3 install aniso8601 pytz
 before_script:
   - cd test
   - cp resources/lrs_properties.py.travis-ci resources/lrs_properties.py
-script: python main.py
+script: python3 main.py

README.md

@@ -10,19 +10,14 @@ For more information about the Tin Can API visit:
 
 <http://tincanapi.com/>
 
-Requires Python 2.7 or later.
+Requires Python 3.6 or later.
 
 ## Installation
-TinCanPython requires [Python 2.7](https://www.python.org/downloads/) or later. Python 3 is not supported.
+TinCanPython requires [Python 3.6](https://www.python.org/downloads/) or later.
 
 If you are installing from the Github repo, you will need to install `aniso8601` and `pytz` (use `sudo` as necessary):
 
-    easy_install aniso8601 pytz
-
-### Recommended optimization
-To speed up the timezone lookups, run:
-
-    pip unzip pytz
+    pip3 install aniso8601 pytz
 
 ## Testing
 The preferred way to run the tests is from the command line.
@@ -45,23 +40,23 @@ It is possible to run all the tests in one go, or just run one part of the tests
 1. `cd` to the `test` directory.
 2. Run
 
-        python main.py
+        python3 main.py
 
 #### One of the tests:
-1. `cd` to the directory containing the test.
+1. `cd` to the root directory.
 2. Run
 
-        python result_test.py
+        python3 -m unittest test.remote_lrs_test
+    Where "remote_lrs_test.py" is the test file you want to run
 
-    (or whatever test you want to run)
 
 #### A single test case of one of the tests:
-1. `cd` to the directory containing the test.
+1. `cd` to the root directory.
 2. Run
 
-        python -m unittest remote_lrs_test.RemoteLRSTest.test_retrieve_statement
+        python3 -m unittest test.remote_lrs_test.RemoteLRSTest.test_save_statements
 
-    Where "remote_lrs_test" is the test file, "RemoteLRSTest" is the class in that file, and "test_retrieve_statement" is the specific test case.
+    Where "remote_lrs_test" is the test file, "RemoteLRSTest" is the class in that file, and "test_save_statements" is the specific test case.
 
 ## API doc generation
 To automatically generate documentation, at the root of the repository run,
@@ -103,22 +98,18 @@ Update setup.py to contain the correct release version and any other new informa
 
 To test the register/upload, run the following commands in the repo directory:
 
-    python setup.py register -r pypitest
-    python setup.py sdist upload -r pypitest
+    python3 setup.py register -r pypitest
+    python3 setup.py sdist upload -r pypitest
 
 You should get no errors and should be able to find this tincan version at https://testpypi.python.org/pypi.
 
 To register/upload to the live PyPI server, run the following commands in the repo directory:
 
-    python setup.py register -r pypi
-    python setup.py sdist upload -r pypi
+    python3 setup.py register -r pypi
+    python3 setup.py sdist upload -r pypi
 
-The new module should be now be installable with pip or easy_install.
-
-    easy_install tincan
-    
-or
+The new module should be now be installable with pip.
 
-    pip install tincan
+    pip3 install tincan
 
 Use sudo as necessary.

examples/example_script.py

@@ -2,7 +2,7 @@
 
 import uuid
 
-from resources import lrs_properties
+from test.resources import lrs_properties
 from tincan import (
     RemoteLRS,
     Statement,
@@ -17,44 +17,44 @@
 
 
 # construct an LRS
-print "constructing the LRS..."
+print("constructing the LRS...")
 lrs = RemoteLRS(
     version=lrs_properties.version,
     endpoint=lrs_properties.endpoint,
     username=lrs_properties.username,
     password=lrs_properties.password,
 )
-print "...done"
+print("...done")
 
 # construct the actor of the statement
-print "constructing the Actor..."
+print("constructing the Actor...")
 actor = Agent(
     name='UserMan',
     mbox='mailto:[email protected]',
 )
-print "...done"
+print("...done")
 
 # construct the verb of the statement
-print "constructing the Verb..."
+print("constructing the Verb...")
 verb = Verb(
     id='http://adlnet.gov/expapi/verbs/experienced',
     display=LanguageMap({'en-US': 'experienced'}),
 )
-print "...done"
+print("...done")
 
 # construct the object of the statement
-print "constructing the Object..."
+print("constructing the Object...")
 object = Activity(
     id='http://tincanapi.com/TinCanPython/Example/0',
     definition=ActivityDefinition(
         name=LanguageMap({'en-US': 'TinCanPython Library'}),
         description=LanguageMap({'en-US': 'Use of, or interaction with, the TinCanPython Library'}),
     ),
 )
-print "...done"
+print("...done")
 
 # construct a context for the statement
-print "constructing the Context..."
+print("constructing the Context...")
 context = Context(
     registration=uuid.uuid4(),
     instructor=Agent(
@@ -63,46 +63,46 @@
     ),
     # language='en-US',
 )
-print "...done"
+print("...done")
 
 # construct the actual statement
-print "constructing the Statement..."
+print("constructing the Statement...")
 statement = Statement(
     actor=actor,
     verb=verb,
     object=object,
     context=context,
 )
-print "...done"
+print("...done")
 
 # save our statement to the remote_lrs and store the response in 'response'
-print "saving the Statement..."
+print("saving the Statement...")
 response = lrs.save_statement(statement)
 
 if not response:
     raise ValueError("statement failed to save")
-print "...done"
+print("...done")
 
 # retrieve our statement from the remote_lrs using the id returned in the response
-print "Now, retrieving statement..."
+print("Now, retrieving statement...")
 response = lrs.retrieve_statement(response.content.id)
 
 if not response.success:
     raise ValueError("statement could not be retrieved")
-print "...done"
+print("...done")
 
-print "constructing new Statement from retrieved statement data..."
+print("constructing new Statement from retrieved statement data...")
 ret_statement = response.content
-print "...done"
+print("...done")
 
 # now, using our old statement and our returned statement, we can send multiple statements
 # note: these statements are logically identical, but are 2 separate objects
-print "saving both Statements"
+print("saving both Statements")
 response = lrs.save_statements([statement, ret_statement])
 
 if not response:
     raise ValueError("statements failed to save")
-print "...done"
+print("...done")
 
 # we can query our statements using an object
 # constructing the query object with common fields
@@ -117,26 +117,26 @@
     "limit": 2,
 }
 
-print "querying statements..."
+print("querying statements...")
 response = lrs.query_statements(query)
 
 if not response:
     raise ValueError("statements could not be queried")
-print "...done"
+print("...done")
 
 # now we will explore saving a document, e.g. a state document
-print "constructing a state document..."
+print("constructing a state document...")
 state_document = StateDocument(
     activity=object,
     agent=actor,
     id='stateDoc',
     content=bytearray('stateDocValue', encoding='utf-8'),
 )
-print "...done"
+print("...done")
 
-print "saving state document..."
+print("saving state document...")
 response = lrs.save_state(state_document)
 
 if not response.success:
     raise ValueError("could not save state document")
-print "...done"
+print("...done")

setup.py

@@ -7,7 +7,7 @@
         'tincan/conversions',
         'tincan/documents',
     ],
-    version='0.0.5',
+    version='1.0.0',
     description='A Python library for implementing Tin Can API.',
     author='Rustici Software',
     author_email='mailto:[email protected]',

test/about_test.py

@@ -15,10 +15,10 @@
 import unittest
 
 if __name__ == '__main__':
-    from main import setup_tincan_path
+    from test.main import setup_tincan_path
 
     setup_tincan_path()
-from test_utils import TinCanBaseTestCase
+from test.test_utils import TinCanBaseTestCase
 from tincan import Version, About
 
 

test/activity_test.py

@@ -11,11 +11,11 @@
 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
-
+import json
 import unittest
 
 if __name__ == '__main__':
-    from main import setup_tincan_path
+    from test.main import setup_tincan_path
 
     setup_tincan_path()
 from tincan import (
@@ -91,12 +91,12 @@ def test_ToJSONFromJSON(self):
         check_str = '{"definition": {}, "id": "test", "objectType": "Activity"}'
         activity = Activity.from_json(json_str)
         self.activityVerificationHelper(activity)
-        self.assertEqual(activity.to_json(), check_str)
+        self.assertEqual(json.loads(activity.to_json()), json.loads(check_str))
 
     def test_ToJSON(self):
         check_str = '{"definition": {}, "id": "test", "objectType": "Activity"}'
         activity = Activity(**{'id': 'test', 'definition': {}, 'object_type': 'Activity'})
-        self.assertEqual(activity.to_json(), check_str)
+        self.assertEqual(json.loads(activity.to_json()), json.loads(check_str))
 
     def test_setDefinitionException(self):
         activity = Activity()

test/activitydefinition_test.py

@@ -11,11 +11,11 @@
 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
-
+import json
 import unittest
 
 if __name__ == '__main__':
-    from main import setup_tincan_path
+    from test.main import setup_tincan_path
 
     setup_tincan_path()
 from tincan import (
@@ -215,7 +215,7 @@ def test_ToJSONIgnoreNone(self):
             'description': {'en-US': 'test'},
             'more_info': None
         })
-        self.assertEqual(adef.to_json(), '{"description": {"en-US": "test"}}')
+        self.assertEqual(json.loads(adef.to_json()), json.loads('{"description": {"en-US": "test"}}'))
 
     def test_ToJSONEmpty(self):
         adef = ActivityDefinition()

test/activitylist_test.py

@@ -11,11 +11,11 @@
 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
-
+import json
 import unittest
 
 if __name__ == '__main__':
-    from main import setup_tincan_path
+    from test.main import setup_tincan_path
 
     setup_tincan_path()
 from tincan import ActivityList, Activity
@@ -93,12 +93,13 @@ def test_ToJSONFromJSON(self):
         json_str = '[{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}]'
         alist = ActivityList.from_json(json_str)
         self.listVerificationHelper(alist)
-        self.assertEqual(alist.to_json(), json_str)
+        self.assertEqual(json.loads(alist.to_json()), json.loads(json_str))
 
     def test_ToJSON(self):
         alist = ActivityList([{"id": "test1"}, {"id": "test2"}])
-        self.assertEqual(alist.to_json(),
-                         '[{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}]')
+        self.assertEqual(json.loads(alist.to_json()),
+                         json.loads(
+                             '[{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}]'))
 
     def test_setItem(self):
         alist = ActivityList([Activity(), Activity()])

test/agent_test.py

@@ -15,7 +15,7 @@
 import unittest
 
 if __name__ == '__main__':
-    from main import setup_tincan_path
+    from test.main import setup_tincan_path
 
     setup_tincan_path()
 from tincan import Agent, AgentAccount