├── .gitignore ├── LICENSE ├── README.rst ├── flow ├── __init__.py └── client.py ├── requirements.txt ├── setup.cfg ├── setup.py └── tests ├── __init__.py └── test_flow.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | 26 | # PyInstaller 27 | # Usually these files are written by a python script from a template 28 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 29 | *.manifest 30 | *.spec 31 | 32 | # Installer logs 33 | pip-log.txt 34 | pip-delete-this-directory.txt 35 | 36 | # Unit test / coverage reports 37 | htmlcov/ 38 | .tox/ 39 | .coverage 40 | .coverage.* 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | *,cover 45 | 46 | # Translations 47 | *.mo 48 | *.pot 49 | 50 | # Django stuff: 51 | *.log 52 | 53 | # Sphinx documentation 54 | docs/_build/ 55 | 56 | # PyBuilder 57 | target/ 58 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ==== 2 | Flow 3 | ==== 4 | 5 | A python client for `Polar Flow`_. 6 | 7 | **NOTE:** This project was created before Polar opened their `Polar AccessLink API`_. You are *much* better off using that. 8 | An official python example can be found at https://github.com/polarofficial/accesslink-example-python 9 | 10 | Features 11 | ======== 12 | 13 | * Fetch a list of activities within given date range 14 | * Fetch the TCX file for any training session 15 | * Fetch raw training session data (**TODO**) 16 | * Fetch activity data (steps, goal, etc...) (**TODO**) 17 | 18 | Install 19 | ======= 20 | 21 | This package isn't on PyPi yet, so the easiest way to install is directly 22 | from the git repository:: 23 | 24 | $ pip install git+git://github.com/campbellr/flow-client.git 25 | 26 | Usage 27 | ===== 28 | 29 | Usage is fairly simple. Simply instantiate a ``FlowClient``, login with your 30 | Polar Flow credentials and fetch activities with the ``activities`` method: 31 | 32 | .. code-block:: python 33 | 34 | >>> from flow import FlowClient 35 | >>> 36 | >>> client = FlowClient() 37 | >>> client.login('username@example.com', 'password') 38 | >>> # no arguments will fetch all activities in the last 30 days 39 | >>> activity = client.activities()[0] 40 | >>> print activity 41 | Activity(63464689) 42 | >>> print activity.type 43 | EXERCISE 44 | >>> print activity.datetime 45 | 2015-03-10T19:38:18.000Z 46 | >>> print activity.distance 47 | 4964.10009766 48 | 49 | The entire list of attributes of an ``Activity`` can be viewed using ``dir``. 50 | 51 | Finally, you can download the tcx file for a given activity with the 52 | ``Activty.tcx`` method: 53 | 54 | .. code-block:: python 55 | 56 | >>> print activity.tcx() 57 | 2015-03-10T19:38:18.000Z426.01000.0 58 | [...] 59 | 60 | Contributing 61 | ============ 62 | 63 | Contributions are greatly appreciated! Feel free to submit a pull request, or file 64 | an issue in our `issue tracker`_. 65 | 66 | .. _Polar Flow: https://flow.polar.com 67 | .. _issue tracker: https://github.com/campbellr/flow-client/issues 68 | .. _Polar AccessLink API: https://www.polar.com/en/accesslink 69 | -------------------------------------------------------------------------------- /flow/__init__.py: -------------------------------------------------------------------------------- 1 | from flow.client import FlowClient 2 | -------------------------------------------------------------------------------- /flow/client.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import logging 3 | from zipfile import ZipFile 4 | from StringIO import StringIO 5 | 6 | import requests 7 | 8 | 9 | FLOW_URL = 'https://flow.polar.com' 10 | FLOW_LOGIN_URL = "{}/ajaxLogin".format(FLOW_URL) 11 | FLOW_LOGIN_POST_URL = "{}/login".format(FLOW_URL) 12 | ACTIVITIES_URL = "{}/training/getCalendarEvents".format(FLOW_URL) 13 | 14 | logger = logging.getLogger(__name__) 15 | 16 | 17 | # TODO: look into this url for gathering training data: 18 | # https://flow.polar.com/training/analysis//range/data 19 | # https://flow.polar.com/training/analysis/71760805/range/data 20 | # TODO: look into this url for gathering activity data: 21 | # https://flow.polar.com/activity/data// 22 | # eg: https://flow.polar.com/activity/data/30.3.2015/10.5.2015 23 | 24 | class FlowClient(object): 25 | 26 | """Interact with the (unofficial) Polar Flow API.""" 27 | 28 | def __init__(self): 29 | self.session = requests.session() 30 | 31 | def login(self, username, password): 32 | postdata = {'email': username, 33 | 'password': password, 34 | 'returnURL': '/'} 35 | # We need to go here to gather some cookies 36 | self.session.get(FLOW_LOGIN_URL) 37 | resp = self.session.post(FLOW_LOGIN_POST_URL, data=postdata) 38 | if resp.status_code != 200: 39 | resp.raise_for_status() 40 | 41 | # FIXME: these aren't really activities as Flow defines them, they're 42 | # training sessions? 43 | # activity is the activity tracking stuff 44 | def activities(self, *args, **kwargs): 45 | """Return all activities between ``start_date`` and ``end_date``. 46 | 47 | ``end_date`` defaults to the current time, ``start_date`` defaults to 48 | 30 days before ``end_date``. 49 | """ 50 | return list(self.iter_activities(*args, **kwargs)) 51 | 52 | def iter_activities(self, start_date=None, end_date=None): 53 | """Return a generator yielding `Activity` objects.""" 54 | logger.debug("Fetching activities between %s and %s", 55 | start_date, end_date) 56 | end_date = end_date or datetime.datetime.now() 57 | start_date = start_date or (end_date - datetime.timedelta(days=30)) 58 | params = {'start': _format_date(start_date), 59 | 'end': _format_date(end_date)} 60 | resp = self.session.get(ACTIVITIES_URL, params=params) 61 | resp.raise_for_status() 62 | for data in resp.json(): 63 | yield Activity(self.session, data) 64 | 65 | 66 | # FIXME: it would be ideal if Activity didn't have to take a session object 67 | # and instead just took an id (or optionally the activity data if already 68 | # available) 69 | class Activity(object): 70 | 71 | """Represents a single activity in Polar Flow. 72 | 73 | ``session`` must be an already authenticated `Session` object. 74 | 75 | """ 76 | 77 | def __init__(self, session, data): 78 | self.session = session 79 | self.data = data 80 | 81 | def __repr__(self): 82 | return "{}({})".format(type(self).__name__, self.data['listItemId']) 83 | 84 | def __getattr__(self, name): 85 | try: 86 | return self.data[name] 87 | except KeyError: 88 | raise AttributeError(name) 89 | 90 | def __dir__(self): 91 | return sorted(set(self.data.keys() + 92 | dir(type(self)) + 93 | list(self.__dict__))) 94 | 95 | def tcx(self): 96 | """Return the contents of the TCX file for the given activity. 97 | 98 | ``activity`` can either be an id or an activity dictionary 99 | (as returned by `get_activities`). 100 | 101 | """ 102 | logging.debug("Fetching TCX file for %s", self.data['url']) 103 | tcx_url = FLOW_URL + self.data['url'] + '/export/tcx' 104 | 105 | resp = self.session.get(tcx_url) 106 | resp.raise_for_status() 107 | with ZipFile(StringIO(resp.content), 'r') as tcx_zip: 108 | namelist = tcx_zip.namelist() 109 | assert len(namelist) == 1, "Expected only one item in zip" 110 | tcx_name = tcx_zip.namelist()[0] 111 | # FIXME: should this return something other than a raw string? 112 | # * parsed xml? 113 | # * Some custom TCX object? 114 | return tcx_zip.read(tcx_name) 115 | 116 | 117 | def _format_date(dt): 118 | return dt.strftime('%d.%m.%Y') 119 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests==2.6.0 2 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | name = flow 3 | author = Ryan Campbell 4 | author-email = campbellr@gmail.com 5 | summary = A python client library for Polar Flow 6 | description-file = README.rst 7 | license = Apache-2 8 | classifier = 9 | Development Status :: 4 - Beta 10 | Environment :: Console 11 | License :: OSI Approved :: Apache Software License 12 | Operating System :: OS Independent 13 | Programming Language :: Python 14 | 15 | [files] 16 | packages = 17 | flow 18 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | from setuptools import setup 3 | 4 | 5 | setup( 6 | setup_requires=['pbr'], 7 | pbr=True, 8 | test_suite='unittest2.collector', 9 | ) 10 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/campbellr/flow-client/eb33e4b4d3188eb07417de1236af9d7bfbf2b507/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_flow.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | from unittest2 import TestCase as _TestCase 4 | import requests 5 | 6 | from flow import FlowClient 7 | 8 | 9 | class TestCase(_TestCase): 10 | @classmethod 11 | def setUpClass(cls): 12 | cls.email = os.environ.get('FLOW_EMAIL') 13 | cls.password = os.environ.get('FLOW_PASSWORD') 14 | if not cls.email or not cls.password: 15 | raise AssertionError("FLOW_EMAIL and FLOW_PASSWORD env " 16 | "variables must be set.") 17 | 18 | 19 | class TestFlowClient(TestCase): 20 | 21 | def test_login_failure(self): 22 | client = FlowClient() 23 | with self.assertRaises(requests.HTTPError): 24 | client.login('username', 'password') 25 | 26 | def test_login_success(self): 27 | client = FlowClient() 28 | client.login(self.email, self.password) 29 | 30 | def test_activities(self): 31 | client = FlowClient() 32 | client.login(self.email, self.password) 33 | activities = client.activities() 34 | self.assertNotEqual(activities, []) 35 | 36 | 37 | class TestActivity(TestCase): 38 | 39 | def setUp(self): 40 | self.client = FlowClient() 41 | self.client.login(self.email, self.password) 42 | self.activity = self.client.activities()[0] 43 | 44 | def test_activity_dir(self): 45 | d = dir(self.activity) 46 | self.assertIn('session', d) 47 | self.assertIn('type', d) 48 | self.assertIn('distance', d) 49 | 50 | def test_activity_getattr(self): 51 | self.assertIsNotNone(self.activity.distance) 52 | 53 | def test_activity_tcx(self): 54 | tcx = self.activity.tcx() 55 | self.assertIsInstance(tcx, str) 56 | self.assertTrue(tcx.startswith("