Initial commit.

Author: stanislavulrych

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+Contributions are welcome, including code, documentation, and examples. 
+
+GitHub issues and PRs are the preferred way to receive contributions. 

README.md

@@ -1,2 +1,28 @@
 # tempo-api-python-client
 Python bindings for Tempo (https://tempo-io.github.io/tempo-api-docs/)
+
+This is a Tempo API client library to simplify the interaction with Tempo timesheets.
+
+
+## Getting Started
+
+```
+from tempoapiclient import client
+
+tempo = client.Tempo(
+    "https://api.tempo.io/core/3",
+    "<your_tempo_api_key>")
+
+worklogs = tempo.get_worklogs("2019-11-10", "2019-11-11")
+
+for i in worklogs:
+    print(i)
+```
+
+## Changelog
+
+- 2019-12-17: Initial version with /worklogs, /work-attributes and /user-schedule
+
+## Contributing
+
+Contribution is welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

requirements.txt

@@ -0,0 +1,2 @@
+requests==2.22.0
+six==1.10.0

setup.py

@@ -0,0 +1,22 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="tempo-api-python-client",
+    version="0.0.1",
+    author="Stanislav Ulrych",
+    author_email="[email protected]",
+    description="Python bindings for Tempo (https://tempo-io.github.io/tempo-api-docs/)",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/stanislavulrych/tempo-api-python-client",
+    packages=setuptools.find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.6',
+)

tempoapiclient/__init__.py

@@ -0,0 +1,106 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+
+
+from __future__ import unicode_literals
+
+import itertools
+import requests
+import six
+
+from calendar import monthrange
+from datetime import date, datetime
+from django.utils.dateparse import parse_datetime, parse_date
+from six.moves.urllib.parse import quote
+
+
+class Tempo(object):
+    # Maximum number of result in single response (pagination)
+    # NOTE: maximum number allowed by API is 1000
+    MAX_RESULTS = 1000
+
+    def __init__(self, base_url, auth_token):
+        self._token = auth_token
+        self.BASE_URL = base_url
+
+    def _resolve_date(self, value):
+        if isinstance(value, datetime):
+            return value.date()
+        if isinstance(value, date):
+            return value
+        parsed = parse_date(value)
+        if not parsed:
+            parsed = parse_datetime(value)
+            if not parsed:
+                raise ValueError()
+            return parsed.date()
+        return parsed
+
+    def _list(self, url, **params):
+        # Resolve parameters
+        url = self.BASE_URL + url
+        headers = { "Authorization": "Bearer {}".format(self._token) }
+        params = params.copy()
+
+        # Return paginated results
+        processed = 0
+        while True:
+            params["offset"] = processed
+            response = requests.get(url, params=params, headers=headers)
+            response.raise_for_status()
+            data = response.json()
+            metadata = data.get("metadata", {})
+            results = data.get("results", [])
+            processed += metadata.get("count", 0)
+            for result in results:
+                yield result
+            if "next" not in metadata or metadata.get("count", 0) < metadata.get("limit", 0):
+                break
+
+    def _get_work_attributes(self):
+        return { x["key"]: x for x in self._list("/work-attributes") }
+
+    def _iterate_worklogs(self, date_from, date_to, user=None):
+        work_attributes = None
+        date_from = self._resolve_date(date_from).isoformat()
+        date_to = self._resolve_date(date_to).isoformat()
+        url = "/worklogs"
+        if user is not None:
+            url += "/user/{}".format(user)
+        params = { "from": date_from, "to": date_to, "limit": self.MAX_RESULTS }
+        for worklog in self._list(url, **params):
+            attributes = (worklog.get("attributes") or {}).get("values") or []
+            resolved_attributes = {}
+            if attributes:
+                if work_attributes is None:
+                    work_attributes = self._get_work_attributes()
+                for attribute in attributes:
+                    key = attribute["key"]
+                    name = work_attributes.get(key, {}).get("name", key)
+                    resolved_attributes[name] = attribute["value"]
+                worklog["attributes"] = resolved_attributes
+            yield worklog
+
+    def get_worklogs(self, date_from, date_to, user=None):
+        return list(self._iterate_worklogs(date_from, date_to, user))
+
+    def _iterate_user_schedule(self, date_from, date_to, user):
+        date_from = self._resolve_date(date_from).isoformat()
+        date_to = self._resolve_date(date_to).isoformat()
+        url = "/user-schedule"
+        if user is not None:
+            url += "/{}".format(user)
+        params = { "from": date_from, "to": date_to, "limit": self.MAX_RESULTS }
+        return self._list(url, **params)
+
+    def get_user_schedule(self, date_from, date_to, user):
+        return list(self.iterate_schedule(date_from, date_to, user))