Merge pull request #19 from Staffjoy/updates

update dev, bump release, update formatting

Author: philipithomas

LICENSE.txt

@@ -1,5 +1,6 @@
 MIT License
-Copyright (c) 2016 Staffjoy, Inc.
+
+Copyright (c) 2016-2017 Staffjoy, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -4,11 +4,11 @@ A light wrapper for the [Staffjoy](https://www.staffjoy.com) API in Python.
 
 This library does not include permissions management, and it is primarily used across microservices internally. Some of its features include internal-only endpoints.
 
-[![Build Status](https://travis-ci.org/Staffjoy/client_python.svg?branch=master)](https://travis-ci.org/Staffjoy/client_python)
+[![Build Status](https://travis-ci.org/Staffjoy/client_python.svg?branch=master)](https://travis-ci.org/Staffjoy/client_python) [![Moonlight](https://img.shields.io/badge/Contractors-1-brightgreen.svg)](https://moonlightwork.com/staffjoy)
 
 ## Installation
 
-`pip install staffjoy`
+`pip install --upgrade staffjoy`
 
 ## Authentication
 
@@ -22,11 +22,7 @@ To get your organization ID, look at the URL path when you go to the Manager app
 
 ## Rate Limits
 
-This client sleeps for .5 seconds after every request. Thus, in a single thread, requests are limited to 120 per minute. This is done to avoid rate limiting. Staffjoy's API currently rate limits to 300 requests per second across keys and IPs. Thus, by using this library, you should never encounter a rate limit (assuming one executing thread per IP address).
-
-## Updates
-
-If you use this library, please subscribe to the [Staffjoy API Updates Google Group](https://groups.google.com/forum/#!forum/staffjoy-api-updates) for important notifications about changes and deprecations.
+This client sleeps after every request in order to limit requests to 120 per minute. This is done to avoid rate limiting. Staffjoy's API currently rate limits to 300 requests per second across keys and IPs. Thus, by using this library, you should never encounter a rate limit (assuming one executing thread per IP address).
 
 ## Usage
 

requirements-test.txt

@@ -1,2 +1,2 @@
-yapf==0.10.0
+yapf==0.16.0
 pytest==2.8.7

setup.py

@@ -1,12 +1,12 @@
 from setuptools import setup, find_packages
 
-version = "0.22"
+version = "0.23"
 setup(name="staffjoy",
       packages=find_packages(),
       version=version,
       description="Staffjoy API Wrapper in Python",
       author="Philip Thomas",
-      author_email="help@staffjoy.com",
+      author_email="philip@staffjoy.com",
       license="MIT",
       url="https://github.com/staffjoy/client_python",
       download_url="https://github.com/StaffJoy/client_python/archive/%s.tar.gz" % version,

staffjoy/client.py

@@ -9,10 +9,8 @@
 
 class Client(Resource):
     def get_organizations(self, limit=25, offset=0, **kwargs):
-        return Organization.get_all(parent=self,
-                                    limit=limit,
-                                    offset=offset,
-                                    **kwargs)
+        return Organization.get_all(
+            parent=self, limit=limit, offset=offset, **kwargs)
 
     def get_organization(self, id):
         return Organization.get(parent=self, id=id)

staffjoy/config.py

@@ -16,7 +16,7 @@ class StageConfig(DefaultConfig):
 class DevelopmentConfig(DefaultConfig):
     ENV = "dev"
     LOG_LEVEL = logging.DEBUG
-    BASE = "http://dev.staffjoy.com/api/v2/"
+    BASE = "http://suite.local/api/v2/"
 
 
 config_from_env = {  # Determined in main.py

staffjoy/resource.py

@@ -17,8 +17,10 @@ class Resource:
     ID_NAME = None  # What is this ID called in the route of children?
     META_ENVELOPES = []  # Metadata keys for what to unpack from response
     ENVELOPE = "data"  # We "envelope" response data in the "data" section
-    TRUTHY_CODES = [requests.codes.ok, requests.codes.created,
-                    requests.codes.no_content, requests.codes.accepted]
+    TRUTHY_CODES = [
+        requests.codes.ok, requests.codes.created, requests.codes.no_content,
+        requests.codes.accepted
+    ]
 
     def __init__(self,
                  key="",
@@ -75,9 +77,8 @@ def get_all(cls, parent=None, **params):
         """Perform a read request against the resource"""
 
         start = datetime.now()
-        r = requests.get(base_obj._url(),
-                         auth=(base_obj.key, ""),
-                         params=params)
+        r = requests.get(
+            base_obj._url(), auth=(base_obj.key, ""), params=params)
         cls._delay_for_ratelimits(start)
 
         if r.status_code not in cls.TRUTHY_CODES:
@@ -89,10 +90,11 @@ def get_all(cls, parent=None, **params):
         return_objects = []
         for data in objects_data:
             # Note that this approach does not get meta data
-            return_objects.append(cls.get(parent=parent,
-                                          id=data.get(cls.ID_NAME, data.get(
-                                              "id")),
-                                          data=data))
+            return_objects.append(
+                cls.get(
+                    parent=parent,
+                    id=data.get(cls.ID_NAME, data.get("id")),
+                    data=data))
 
         return return_objects
 

test/test_functional.py

@@ -58,9 +58,10 @@ def test_org_crud():
     r.patch(name="Cocina")
     logger.debug("Adding worker")
     r.get_workers()
-    r.create_worker(email=TEST_WORKER,
-                    min_hours_per_workweek=30,
-                    max_hours_per_workweek=40)
+    r.create_worker(
+        email=TEST_WORKER,
+        min_hours_per_workweek=30,
+        max_hours_per_workweek=40)
 
     logger.debug("Deleting worker")
     r.delete()