Merge pull request #12 from edx/clintonb/cleanup

Infrastructure Cleanup

.travis.yml

 language: python
-branches:
-    only:
-      - master
 python:
   - "2.7"
 install:
   - pip install coveralls
-  - pip install -r docs-requirements.txt
-  - pip install -r test-requirements.txt
-  - pip install -r quality-requirements.txt
+  - pip install -r requirements.txt
 script:
   - make
 after_success:
-  - coveralls
\ No newline at end of file
+  - coveralls

README.md

-# edx-user-state-client
-Python module for storing/querying user state in edx-platform. 
-Contains interface which will handle all backends for user states.

README.rst

+Part of `edX code`_.
+
+.. _`edX code`: http://code.edx.org/
+
+edx-user-state-client |Build Status| |Coverage Status|
+======================================================
+
+Python module for storing/querying user state in edx-platform. Contains interface which will handle
+all backends for user states.
+
+.. |Build Status| image:: https://travis-ci.org/edx/edx-user-state-client.svg?branch=master
+   :target: https://travis-ci.org/edx/edx-user-state-client
+.. |Coverage Status| image:: https://coveralls.io/repos/github/edx/edx-user-state-client/badge.svg?branch=master
+   :target: https://coveralls.io/github/edx/edx-user-state-client?branch=master
+
+
+How to Contribute
+-----------------
+Contributions are very welcome, but please note that edx-user-state-client is currently an early stage
+work-in-progress and is changing frequently at this time.
+
+See our `CONTRIBUTING`_ file for more information – it also contains guidelines for how to
+maintain high code quality, which will make your contribution more likely to be accepted.
+
+.. _CONTRIBUTING: https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst
+
+
+Reporting Security Issues
+-------------------------
+Please do not report security issues in public. Please email security@edx.org.
+
+
+Mailing List and IRC Channel
+----------------------------
+
+You can discuss this code on the `edx-code Google Group`_ or in the
+``edx-code`` IRC channel on Freenode.
+
+.. _edx-code Google Group: https://groups.google.com/forum/#!forum/edx-code

docs-requirements.txt

--r requirements.txt
--r doc/requirements.txt
--e .

edx_user_state_client/interface.py

@@ -4,9 +4,9 @@ A baseclass for a generic client for accessing XBlock Scope.user_state field dat
 
 from abc import abstractmethod
 from collections import namedtuple
+from datetime import datetime
 
 from contracts import contract, new_contract, ContractsMeta
-from datetime import datetime
 from opaque_keys.edx.keys import UsageKey, DefinitionKey
 from xblock.fields import Scope, ScopeBase
 

edx_user_state_client/tests.py

@@ -17,13 +17,14 @@ test suite, use the snippet:
 
 from datetime import datetime
 from unittest import TestCase
-import pytz
 
+import pytz
 from contracts import contract
-from edx_user_state_client.interface import XBlockUserStateClient, XBlockUserState
 from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator
 from xblock.fields import Scope
 
+from edx_user_state_client.interface import XBlockUserStateClient, XBlockUserState
+
 
 class _UserStateClientTestUtils(TestCase):
     """

pylintrc

@@ -22,7 +22,6 @@
 #
 # ------------------------------
 [MASTER]
-profile = no
 ignore = 
 persistent = yes
 load-plugins = edx_lint.pylint
@@ -48,6 +47,7 @@ disable =
 	too-many-branches,
 	too-many-arguments,
 	too-many-locals,
+	unused-wildcard-import,
 	duplicate-code
 
 [REPORTS]
@@ -55,10 +55,8 @@ output-format = text
 files-output = no
 reports = no
 evaluation = 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-comment = no
 
 [BASIC]
-required-attributes = 
 bad-functions = map,filter,apply,input
 module-rgx = (([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
 const-rgx = (([A-Z_][A-Z0-9_]*)|(__.*__)|log|urlpatterns)$
@@ -72,7 +70,7 @@ class-attribute-rgx = ([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
 inlinevar-rgx = [A-Za-z_][A-Za-z0-9_]*$
 good-names = f,i,j,k,db,ex,Run,_,__
 bad-names = foo,bar,baz,toto,tutu,tata
-no-docstring-rgx = __.*__|test_.+|setUp|tearDown
+no-docstring-rgx = __.*__$|test_.+|setUp$|setUpClass$|tearDown$|tearDownClass$|Meta$
 docstring-min-length = -1
 
 [FORMAT]
@@ -95,7 +93,7 @@ ignore-imports = no
 [TYPECHECK]
 ignore-mixin-members = yes
 ignored-classes = SQLObject
-zope = no
+unsafe-load-any-extension = yes
 generated-members = 
 	REQUEST,
 	acl_users,
@@ -125,7 +123,6 @@ dummy-variables-rgx = _|dummy|unused|.*_unused
 additional-builtins = 
 
 [CLASSES]
-ignore-iface-methods = isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
 defining-attr-methods = __init__,__new__,setUp
 valid-classmethod-first-arg = cls
 valid-metaclass-classmethod-first-arg = mcs
@@ -151,4 +148,4 @@ int-import-graph =
 [EXCEPTIONS]
 overgeneral-exceptions = Exception
 
-# 72ba3e91d367cc6c60837a8b467ed70f8fa77e7e
+# 34eaa1014ee153fd195488d853ed9e725e43ac35

pylintrc_tweaks

+[MASTER]
+load-plugins = edx_lint.pylint

quality-requirements.txt

-pep8

requirements.txt

-git+https://github.com/edx/edx-lint.git@ed8c8d2a0267d4d42f43642d193e25f8bd575d9b#egg=edx_lint==0.2.3
-git+https://github.com/edx/opaque-keys.git@df0dd602869e498e512659bb4bd243309e30e19a#egg=opaque-keys 
+-e .
+-r doc/requirements.txt
+-r test-requirements.txt
\ No newline at end of file

setup.py

@@ -7,8 +7,8 @@ setup(
         "edx_user_state_client",
     ],
     install_requires=[
-        "PyContracts",
-        "opaque-keys",
-        "xblock",
+        "PyContracts>=1.7.1,<2.0.0",
+        "edx-opaque-keys>=0.2.0,<1.0.0",
+        "xblock>=0.4,<1.0.0",
     ]
 )

test-requirements.txt

-tox
+coverage>=4.0.3,<5.0.0
+edx-lint>=0.4.0,<1.0.0
+nose>=1.3.7,<2.0.0
+pep8>=1.7.0,<2.0.0
+tox>=2.3.1,<3.0.0

tox.ini

@@ -5,7 +5,4 @@ skip_missing_interpreters=true
 [testenv]
 deps =
     -rrequirements.txt
-    coverage>=4.0a0
-    nose
-    -e.
-commands = coverage run -m nose
\ No newline at end of file
+commands = coverage run -m nose