├── .gitignore ├── .vscode └── settings.json ├── LICENSE ├── app-preview.jpg ├── config-template.ini ├── readme.md ├── requirements.txt └── sleep-data.py /.gitignore: -------------------------------------------------------------------------------- 1 | sleep-data-config-private.json 2 | config.ini 3 | 4 | # Byte-compiled / optimized / DLL files 5 | __pycache__/ 6 | *.py[cod] 7 | *$py.class 8 | 9 | # C extensions 10 | *.so 11 | 12 | # Distribution / packaging 13 | .Python 14 | build/ 15 | develop-eggs/ 16 | dist/ 17 | downloads/ 18 | eggs/ 19 | .eggs/ 20 | lib/ 21 | lib64/ 22 | parts/ 23 | sdist/ 24 | var/ 25 | wheels/ 26 | share/python-wheels/ 27 | *.egg-info/ 28 | .installed.cfg 29 | *.egg 30 | MANIFEST 31 | 32 | # PyInstaller 33 | # Usually these files are written by a python script from a template 34 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 35 | *.manifest 36 | *.spec 37 | 38 | # Installer logs 39 | pip-log.txt 40 | pip-delete-this-directory.txt 41 | 42 | # Unit test / coverage reports 43 | htmlcov/ 44 | .tox/ 45 | .nox/ 46 | .coverage 47 | .coverage.* 48 | .cache 49 | nosetests.xml 50 | coverage.xml 51 | *.cover 52 | *.py,cover 53 | .hypothesis/ 54 | .pytest_cache/ 55 | cover/ 56 | 57 | # Translations 58 | *.mo 59 | *.pot 60 | 61 | # Django stuff: 62 | *.log 63 | local_settings.py 64 | db.sqlite3 65 | db.sqlite3-journal 66 | 67 | # Flask stuff: 68 | instance/ 69 | .webassets-cache 70 | 71 | # Scrapy stuff: 72 | .scrapy 73 | 74 | # Sphinx documentation 75 | docs/_build/ 76 | 77 | # PyBuilder 78 | .pybuilder/ 79 | target/ 80 | 81 | # Jupyter Notebook 82 | .ipynb_checkpoints 83 | 84 | # IPython 85 | profile_default/ 86 | ipython_config.py 87 | 88 | # pyenv 89 | # For a library or package, you might want to ignore these files since the code is 90 | # intended to run in multiple environments; otherwise, check them in: 91 | # .python-version 92 | 93 | # pipenv 94 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 95 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 96 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 97 | # install all needed dependencies. 98 | #Pipfile.lock 99 | 100 | # poetry 101 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 102 | # This is especially recommended for binary packages to ensure reproducibility, and is more 103 | # commonly ignored for libraries. 104 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 105 | #poetry.lock 106 | 107 | # pdm 108 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 109 | #pdm.lock 110 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 111 | # in version control. 112 | # https://pdm.fming.dev/#use-with-ide 113 | .pdm.toml 114 | 115 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 116 | __pypackages__/ 117 | 118 | # Celery stuff 119 | celerybeat-schedule 120 | celerybeat.pid 121 | 122 | # SageMath parsed files 123 | *.sage.py 124 | 125 | # Environments 126 | .env 127 | .venv 128 | env/ 129 | venv/ 130 | ENV/ 131 | env.bak/ 132 | venv.bak/ 133 | 134 | # Spyder project settings 135 | .spyderproject 136 | .spyproject 137 | 138 | # Rope project settings 139 | .ropeproject 140 | 141 | # mkdocs documentation 142 | /site 143 | 144 | # mypy 145 | .mypy_cache/ 146 | .dmypy.json 147 | dmypy.json 148 | 149 | # Pyre type checker 150 | .pyre/ 151 | 152 | # pytype static type analyzer 153 | .pytype/ 154 | 155 | # Cython debug symbols 156 | cython_debug/ 157 | 158 | # PyCharm 159 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 160 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 161 | # and can be added to the global gitignore or merged into this file. For a more nuclear 162 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 163 | #.idea/ 164 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "cmake.configureOnOpen": false, 3 | "editor.guides.bracketPairs": true, 4 | "[python]": { 5 | "editor.defaultFormatter": "ms-python.black-formatter" 6 | }, 7 | "python.formatting.provider": "none" 8 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /app-preview.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sam-roberts/oura-data-visualiser/fb496607c0b05391d3fe5bac834d38cad25c9738/app-preview.jpg -------------------------------------------------------------------------------- /config-template.ini: -------------------------------------------------------------------------------- 1 | # You will need to configure everything from here ================== 2 | [db] 3 | dbtype = postgresql 4 | host = localhost 5 | password = hunter2 6 | dbname = sleepdb 7 | username = postgres 8 | tablename = sleep_sessions 9 | 10 | [user] 11 | # Get your personal token at https://cloud.ouraring.com/user/sign-in?next=%2Fpersonal-access-tokens 12 | personal_token = abc 13 | # Set the start date you want to fetch the data from 14 | start_date = 2023-01-01 15 | # Toggle for whether or not naps are included in overall sleep total calculations. (Only the long_sleep for that day is used) 16 | include_naps = False 17 | 18 | 19 | # =========================================================And here. 20 | [oura] 21 | sleep_api_url = https://api.ouraring.com/v2/usercollection/daily_sleep 22 | sleep_routes_api_url = https://api.ouraring.com/v2/usercollection/sleep 23 | 24 | 25 | # In general these should be left alone unless you're working on developing the script 26 | [dev] 27 | debug_mode = False 28 | clear_tables = True 29 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # Oura sleep data visualiser 2 | 3 | This is a Python project that allows you to pull your data from the Oura API using a personal access token, save it to a local PostgreSQL database, then use tools like Grafana to revisualise it. Currently the data being scraped is: 4 | 5 | - Sleep score including score breakdown (e.g. efficiency, latency, etc) 6 | - Sleep durations for: 7 | - Total time in bed duration 8 | - Total sleep duration 9 | - REM sleep duration 10 | - Deep sleep duration 11 | 12 | 13 | Although last change was made approx 3 months ago - script should be working as of this edit, October 2023. 14 | 15 | ![Example of visualising your sleep data with this tool](/app-preview.jpg) 16 | 17 | ## Limitations and warnings 18 | 19 | This tool was created for PERSONAL USE and such is not intended as a production-quality community tool. Use at your own risk. In my configuration, all necessary programs are running under a Rapsberry Pi running . The tool should work on other platforms such as MacOS, Windows, other Linux distriubtions. Support for other platforms will not be provided at this stage. 20 | 21 | ## Installation 22 | 23 | ### Prerequisites 24 | 25 | - Python 3.x: The project requires Python 3.x to be installed. If Python is not installed, you can download it from the official Python website: 26 | - PostGreSQL: The project attempts to connect to a Postgres database to store its data. 27 | 28 | ### Install Postgres (linux) - Other database types now supported, but not tested 29 | 30 | Installing Postgres is recommended first. 31 | For proper documentation, follow instructions for your platform at: (or consider using something like brew on macOS) 32 | or 33 | General instructions: 34 | 35 | 1. Update your package list and install postgres 36 | 37 | ```bash 38 | sudo apt update && sudo apt install postgresql 39 | ``` 40 | 41 | 2. Switch to the postgres user using 42 | 43 | ```bash 44 | sudo -i -u postgres 45 | ``` 46 | 47 | 3. Access the PostgreSQL terminal by running: 48 | 49 | ```bash 50 | psql 51 | ``` 52 | 53 | 4. Create the database you will use to host the data (by default this tool calls it 'sleepdb') 54 | 55 | ```sql 56 | CREATE DATABASE sleepdb; 57 | ``` 58 | 59 | ### Set up a Virtual Environment (Optional) 60 | 61 | Setting up a virtual environment is recommended to keep the project dependencies isolated. Follow these steps to set up a virtual environment. Note on MacOS you may need to follow some of the steps described in 62 | 63 | 1. Change to the project directory: 64 | 65 | ```bash 66 | cd your-repository 67 | ``` 68 | 69 | 2. Create a virtual environment: 70 | 71 | ```bash 72 | python3 -m venv venv 73 | ``` 74 | 75 | 3. Activate the virtual environment: 76 | 77 | ```bash 78 | source venv/bin/activate 79 | ``` 80 | 81 | ### Install Dependencies 82 | 83 | 1. Ensure that the virtual environment is activated (if you set up one). 84 | 2. Install the project dependencies by running the following command: 85 | 86 | ```bash 87 | pip install -r requirements.txt 88 | ``` 89 | 90 | ### Configuration 91 | 92 | 1. Open the `config-template.ini` file in a text editor. 93 | 2. Fill out all configurations in the db and user sections 94 | 3. Save the file. 95 | 4. Set an environment variable to tell your operating system where to find this file. (Add to ~/.bashrc to not need to do this every time program is run) 96 | 97 | ```bash 98 | export OURA_SLEEP_CONFIG_PATH="e.g. PATH/TO/YOUR/CONFIG-FILE.ini" 99 | ``` 100 | 101 | ### Set up 102 | 103 | As long as a database exists as defined in your config file, the program will create the necessary table for you. 104 | 105 | ```bash 106 | python3 sleep-data.py 107 | ``` 108 | 109 | ### Installing Grafana 110 | 111 | Grafana allows your to visualise data from a range of sources. Follow their guide at: 112 | 113 | ### Connecting Grafana to your Postgres database 114 | 115 | Follow this guide for connecting grafana to your postgres server 116 | 117 | 118 | ### Example of Query to show scores in Grafana 119 | 120 | Create a new Visualization on your main Grafana dashboard. Set the data source to PostgreSQL. 121 | Under the 'code' query builder, you can now pull out the fields you need. 122 | 123 | ```sql 124 | SELECT score as "Sleep Score", date FROM sleep_sessions WHERE $__timeFilter(date) 125 | ``` 126 | 127 | ## Usage 128 | 129 | 1. Ensure that you have followed setup instructions (above) 130 | 2. Run the Python script by executing the following command: 131 | 132 | ```bash 133 | python3 sleep-data.py 134 | ``` 135 | 136 | ## Major changes released 19/7/23 137 | 138 | 1. Migrated from psycopg2 to sqlalchemy to allow for more generic db handling 139 | 2. Added support for pulling in sleep durations 140 | 3. Various code refactoring and readability improvements 141 | 142 | ## Setting up the script to run automatically 143 | 144 | You can use a tool like cron to run the script every day. 145 | 146 | ## Upcoming improvements 147 | 148 | - Add installation shell script to speed up installation. 149 | - Look at Docker container version of tool. 150 | - Pull in more information from Oura. At the moment only sleep data is pulled. 151 | 152 | ## Known issues 153 | 154 | - checkConfig() fails if no password is set, which is a valid configuration on postgres. 155 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | autopep8==2.0.2 2 | certifi==2023.5.7 3 | charset-normalizer==3.2.0 4 | greenlet==2.0.2 5 | idna==3.4 6 | mypy==1.4.1 7 | mypy-extensions==1.0.0 8 | pip-autoremove==0.10.0 9 | psycopg2-binary==2.9.6 10 | pycodestyle==2.10.0 11 | requests==2.31.0 12 | SQLAlchemy==2.0.19 13 | tomli==2.0.1 14 | types-psycopg2==2.9.21.10 15 | types-requests==2.31.0.1 16 | types-urllib3==1.26.25.13 17 | typing_extensions==4.7.1 18 | urllib3==2.0.3 19 | -------------------------------------------------------------------------------- /sleep-data.py: -------------------------------------------------------------------------------- 1 | # built-in libraries 2 | import configparser 3 | import logging 4 | import os 5 | from datetime import date, datetime, timedelta 6 | from http import HTTPStatus 7 | from typing import Dict, List, Optional 8 | 9 | # third-party libraries 10 | import requests 11 | from sqlalchemy import Column, Date, Engine, Integer, MetaData, Table, create_engine 12 | 13 | 14 | def getResponseFromAPI( 15 | API_URl: str, PERSONAL_TOKEN: str, myParams: Dict 16 | ) -> Optional[Dict]: 17 | # Optional: Define headers or authentication tokens if required by the API 18 | headers = { 19 | "Authorization": f"Bearer {PERSONAL_TOKEN}", 20 | "Content-Type": "application/json", 21 | } 22 | 23 | try: 24 | response = requests.get(API_URl, headers=headers, params=myParams) 25 | 26 | # Check the response status code 27 | if response.status_code == HTTPStatus.OK: 28 | data = response.json() # Get the response data in JSON format 29 | # Process and work with the response data as needed 30 | return data 31 | else: 32 | print(f"Request failed with status code: {response.status_code}") 33 | return None 34 | 35 | except requests.exceptions.RequestException as e: 36 | print(f"Request error: {e}") 37 | return None 38 | 39 | 40 | def checkConfig(config) -> bool: 41 | # Check if valid configuration file 42 | # TODO MAKE SURE THE USER PROVIDES A VALID CONFIG FILE 43 | return True 44 | 45 | 46 | def getSleepDataOnDate(sleepData, compareDate) -> List[Dict]: 47 | # support multiple sets of data on a day 48 | results = [item for item in sleepData if item["day"] == str(compareDate)] 49 | return results 50 | 51 | 52 | def getSleepDataSum(additionalDayData, config: configparser.ConfigParser): 53 | combinedData = { 54 | "total_sleep_duration": 0, 55 | "rem_sleep_duration": 0, 56 | "time_in_bed": 0, 57 | "deep_sleep_duration": 0, 58 | } 59 | 60 | for item in additionalDayData: 61 | # If in config we include naps then add all sleep sessions for the day up, otherwise only take the long sleep value 62 | if config["user"].getboolean("include_naps"): 63 | combinedData["total_sleep_duration"] += item["total_sleep_duration"] 64 | combinedData["rem_sleep_duration"] += item["rem_sleep_duration"] 65 | combinedData["time_in_bed"] += item["time_in_bed"] 66 | combinedData["deep_sleep_duration"] += item["deep_sleep_duration"] 67 | else: 68 | if item["type"] == "long_sleep": 69 | combinedData["total_sleep_duration"] = item["total_sleep_duration"] 70 | combinedData["rem_sleep_duration"] = item["rem_sleep_duration"] 71 | combinedData["time_in_bed"] = item["time_in_bed"] 72 | combinedData["deep_sleep_duration"] = item["deep_sleep_duration"] 73 | return combinedData 74 | 75 | return combinedData 76 | 77 | 78 | def clearAndCreateTable(engine: Engine, meta: MetaData, table: Table, config): 79 | with engine.connect() as connection: 80 | # Check if the table already exists 81 | if connection.dialect.has_table(connection, config["db"]["tablename"]): 82 | # Drop the table if it exists 83 | table.drop(engine) 84 | print(f"{config['db']['tablename']} table has been dropped.") 85 | table.create(engine) 86 | 87 | 88 | def populateDb( 89 | engine: Engine, 90 | meta: MetaData, 91 | tableSleep: Table, 92 | config: configparser.ConfigParser, 93 | sleepData: Dict, 94 | moreSleepData: Dict, 95 | todayDate: str, 96 | ): 97 | # Find the range of dates to loop over 98 | dateFormat = "%Y-%m-%d" 99 | firstDate = datetime.strptime(config["user"]["start_date"], dateFormat).date() 100 | lastDate = datetime.strptime(todayDate, dateFormat).date() 101 | dateDelta = (lastDate - firstDate).days 102 | 103 | # List of all the days between the range 104 | allDays = [firstDate + timedelta(days=i) for i in range(dateDelta + 1)] 105 | if config["dev"].getboolean("debug_mode"): 106 | print("First day:", firstDate, "last day", lastDate) 107 | print("There should be ", len(allDays), "of data") 108 | 109 | # Loop over all the days, and if there's no data for that day, just fill it with zeroes 110 | missingDays = 0 111 | with engine.connect() as connection: 112 | for calendarDay in allDays: 113 | # Grab the data from our API response for that particular day 114 | dayData = getSleepDataOnDate(sleepData, calendarDay) 115 | additionalDayData = getSleepDataOnDate(moreSleepData, calendarDay) 116 | 117 | # Days can have multiple sleep sessions (e.g. naps), so we need to deal with those 118 | if len(additionalDayData) > 1 and config["dev"].getboolean("debug_mode"): 119 | print(calendarDay, "had", len(additionalDayData), "sleep sessions") 120 | aggregateDayData = getSleepDataSum(additionalDayData, config) 121 | 122 | # if we do have data then get correct values 123 | # We can assume the first elmenet of DayData because length should only be 1 124 | if len(dayData) > 0 and additionalDayData is not None: 125 | inStatment = tableSleep.insert().values( 126 | date=dayData[0].get("day"), 127 | score=dayData[0]["score"], 128 | deep_sleep=dayData[0]["contributors"]["deep_sleep"], 129 | efficiency=dayData[0]["contributors"]["efficiency"], 130 | latency=dayData[0]["contributors"]["latency"], 131 | rem_sleep=dayData[0]["contributors"]["rem_sleep"], 132 | restfulness=dayData[0]["contributors"]["restfulness"], 133 | timing=dayData[0]["contributors"]["timing"], 134 | total_sleep=dayData[0]["contributors"]["total_sleep"], 135 | total_sleep_duration=aggregateDayData["total_sleep_duration"], 136 | rem_sleep_duration=aggregateDayData["rem_sleep_duration"], 137 | time_in_bed=aggregateDayData["time_in_bed"], 138 | deep_sleep_duration=aggregateDayData["deep_sleep_duration"], 139 | ) 140 | else: 141 | inStatment = tableSleep.insert().values(date=calendarDay.isoformat()) 142 | print( 143 | "..." * 3, "Oura wasn't worn (or there is no data) on", calendarDay 144 | ) 145 | missingDays += 1 146 | connection.execute(inStatment) 147 | connection.commit() 148 | 149 | 150 | def getTable(config, meta): 151 | return Table( 152 | config["db"]["tablename"], 153 | meta, 154 | Column("date", Date, primary_key=True), 155 | Column("score", Integer), 156 | Column("deep_sleep", Integer), 157 | Column("efficiency", Integer), 158 | Column("latency", Integer), 159 | Column("rem_sleep", Integer), 160 | Column("restfulness", Integer), 161 | Column("timing", Integer), 162 | Column("total_sleep", Integer), 163 | Column("total_sleep_duration", Integer), 164 | Column("rem_sleep_duration", Integer), 165 | Column("time_in_bed", Integer), 166 | Column("deep_sleep_duration", Integer), 167 | ) 168 | 169 | 170 | def getSleepData(config, myParams): 171 | sleepData = getResponseFromAPI( 172 | config["oura"]["sleep_api_url"], config["user"]["personal_token"], myParams 173 | ) 174 | sleepData = sleepData.get("data") 175 | return sleepData 176 | 177 | 178 | def getMoreSleepData(config, myParams): 179 | moreSleepData = getResponseFromAPI( 180 | config["oura"]["sleep_routes_api_url"], 181 | config["user"]["personal_token"], 182 | myParams, 183 | ) 184 | moreSleepData = moreSleepData.get("data") 185 | return moreSleepData 186 | 187 | 188 | def setupLogging(): 189 | logging.basicConfig(level=logging.ERROR) 190 | logging.getLogger("sqlalchemy.engine").setLevel(logging.ERROR) 191 | logging.getLogger("sqlalchemy.pool").setLevel(logging.ERROR) 192 | 193 | 194 | def main(): 195 | # Setup configuration file 196 | config_path = os.environ["OURA_SLEEP_CONFIG_PATH"] 197 | config = configparser.ConfigParser() 198 | config.read(config_path) 199 | if not checkConfig(config): 200 | print("Configuration file is invalid, check file and try again. Exiting") 201 | return 202 | 203 | # Fetch data 204 | todayDate = date.today().strftime("%Y-%m-%d") 205 | 206 | # Define start and end date we want data for 207 | myParams = {"start_date": config["user"]["start_date"], "end_date": todayDate} 208 | 209 | # Get results from sleep api (e.g. overall score) 210 | sleepData = getSleepData(config, myParams) 211 | 212 | # Get additional sleep data (e.g. rem time, deep time, in bed duration, etc) 213 | moreSleepData = getMoreSleepData(config, myParams) 214 | 215 | # Connect to database 216 | engine = create_engine( 217 | f"{config['db']['dbtype']}://{config['db']['username']}:{config['db']['password']}@{config['db']['host']}/{config['db']['dbname']}" 218 | ) 219 | meta = MetaData() 220 | setupLogging() 221 | 222 | # Create table object for sleep data 223 | table = getTable(config, meta) 224 | 225 | # Create the table in the database 226 | clearAndCreateTable(engine, meta, table, config) 227 | populateDb(engine, meta, table, config, sleepData, moreSleepData, todayDate) 228 | 229 | 230 | if __name__ == "__main__": 231 | main() 232 | --------------------------------------------------------------------------------