Package: passive-data-kit-client
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION1. Definitions."License" shall mean the terms and conditions for use, reproduction,and distribution as defined by Sections 1 through 9 of this document."Licensor" shall mean the copyright owner or entity authorized bythe copyright owner that is granting the License."Legal Entity" shall mean the union of the acting entity and allother entities that control, are controlled by, or are under commoncontrol with that entity. For the purposes of this definition,"control" means (i) the power, direct or indirect, to cause thedirection or management of such entity, whether by contract orotherwise, or (ii) ownership of fifty percent (50%) or more of theoutstanding shares, or (iii) beneficial ownership of such entity."You" (or "Your") shall mean an individual or Legal Entityexercising permissions granted by this License."Source" form shall mean the preferred form for making modifications,including but not limited to software source code, documentationsource, and configuration files."Object" form shall mean any form resulting from mechanicaltransformation or translation of a Source form, including butnot limited to compiled object code, generated documentation,and conversions to other media types."Work" shall mean the work of authorship, whether in Source orObject form, made available under the License, as indicated by acopyright notice that is included in or attached to the work(an example is provided in the Appendix below)."Derivative Works" shall mean any work, whether in Source or Objectform, that is based on (or derived from) the Work and for which theeditorial revisions, annotations, elaborations, or other modificationsrepresent, as a whole, an original work of authorship. For the purposesof this License, Derivative Works shall not include works that remainseparable from, or merely link (or bind by name) to the interfaces of,the Work and Derivative Works thereof."Contribution" shall mean any work of authorship, includingthe original version of the Work and any modifications or additionsto that Work or Derivative Works thereof, that is intentionallysubmitted to Licensor for inclusion in the Work by the copyright owneror by an individual or Legal Entity authorized to submit on behalf ofthe copyright owner. For the purposes of this definition, "submitted"means any form of electronic, verbal, or written communication sentto the Licensor or its representatives, including but not limited tocommunication on electronic mailing lists, source code control systems,and issue tracking systems that are managed by, or on behalf of, theLicensor for the purpose of discussing and improving the Work, butexcluding communication that is conspicuously marked or otherwisedesignated in writing by the copyright owner as "Not a Contribution.""Contributor" shall mean Licensor and any individual or Legal Entityon behalf of whom a Contribution has been received by Licensor andsubsequently incorporated within the Work.2. Grant of Copyright License. Subject to the terms and conditions ofthis License, each Contributor hereby grants to You a perpetual,worldwide, non-exclusive, no-charge, royalty-free, irrevocablecopyright license to reproduce, prepare Derivative Works of,publicly display, publicly perform, sublicense, and distribute theWork and such Derivative Works in Source or Object form.3. Grant of Patent License. Subject to the terms and conditions ofthis License, each Contributor hereby grants to You a perpetual,worldwide, non-exclusive, no-charge, royalty-free, irrevocable(except as stated in this section) patent license to make, have made,use, offer to sell, sell, import, and otherwise transfer the Work,where such license applies only to those patent claims licensableby such Contributor that are necessarily infringed by theirContribution(s) alone or by combination of their Contribution(s)with the Work to which such Contribution(s) was submitted. If Youinstitute patent litigation against any entity (including across-claim or counterclaim in a lawsuit) alleging that the Workor a Contribution incorporated within the Work constitutes director contributory patent infringement, then any patent licensesgranted to You under this License for that Work shall terminateas of the date such litigation is filed.4. Redistribution. You may reproduce and distribute copies of theWork or Derivative Works thereof in any medium, with or withoutmodifications, and in Source or Object form, provided that Youmeet the following conditions:(a) You must give any other recipients of the Work orDerivative Works a copy of this License; and(b) You must cause any modified files to carry prominent noticesstating that You changed the files; and(c) You must retain, in the Source form of any Derivative Worksthat You distribute, all copyright, patent, trademark, andattribution notices from the Source form of the Work,excluding those notices that do not pertain to any part ofthe Derivative Works; and(d) If the Work includes a "NOTICE" text file as part of itsdistribution, then any Derivative Works that You distribute mustinclude a readable copy of the attribution notices containedwithin such NOTICE file, excluding those notices that do notpertain to any part of the Derivative Works, in at least oneof the following places: within a NOTICE text file distributedas part of the Derivative Works; within the Source form ordocumentation, if provided along with the Derivative Works; or,within a display generated by the Derivative Works, if andwherever such third-party notices normally appear. The contentsof the NOTICE file are for informational purposes only anddo not modify the License. You may add Your own attributionnotices within Derivative Works that You distribute, alongsideor as an addendum to the NOTICE text from the Work, providedthat such additional attribution notices cannot be construedas modifying the License.You may add Your own copyright statement to Your modifications andmay provide additional or different license terms and conditionsfor use, reproduction, or distribution of Your modifications, orfor any such Derivative Works as a whole, provided Your use,reproduction, and distribution of the Work otherwise complies withthe conditions stated in this License.5. Submission of Contributions. Unless You explicitly state otherwise,any Contribution intentionally submitted for inclusion in the Workby You to the Licensor shall be under the terms and conditions ofthis License, without any additional terms or conditions.Notwithstanding the above, nothing herein shall supersede or modifythe terms of any separate license agreement you may have executedwith Licensor regarding such Contributions.6. Trademarks. This License does not grant permission to use the tradenames, trademarks, service marks, or product names of the Licensor,except as required for reasonable and customary use in describing theorigin of the Work and reproducing the content of the NOTICE file.7. Disclaimer of Warranty. Unless required by applicable law oragreed to in writing, Licensor provides the Work (and eachContributor provides its Contributions) on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express orimplied, including, without limitation, any warranties or conditionsof TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR APARTICULAR PURPOSE. You are solely responsible for determining theappropriateness of using or redistributing the Work and assume anyrisks associated with Your exercise of permissions under this License.8. Limitation of Liability. In no event and under no legal theory,whether in tort (including negligence), contract, or otherwise,unless required by applicable law (such as deliberate and grosslynegligent acts) or agreed to in writing, shall any Contributor beliable to You for damages, including any direct, indirect, special,incidental, or consequential damages of any character arising as aresult of this License or out of the use or inability to use theWork (including but not limited to damages for loss of goodwill,work stoppage, computer failure or malfunction, or any and allother commercial damages or losses), even if such Contributorhas been advised of the possibility of such damages.9. Accepting Warranty or Additional Liability. While redistributingthe Work or Derivative Works thereof, You may choose to offer,and charge a fee for, acceptance of support, warranty, indemnity,or other liability obligations and/or rights consistent with thisLicense. However, in accepting such obligations, You may act onlyon Your own behalf and on Your sole responsibility, not on behalfof any other Contributor, and only if You agree to indemnify,defend, and hold each Contributor harmless for any liabilityincurred by, or claims asserted against, such Contributor by reasonof your accepting any such warranty or additional liability.END OF TERMS AND CONDITIONSAPPENDIX: How to apply the Apache License to your work.To apply the Apache License to your work, attach the followingboilerplate notice, with the fields enclosed by brackets "[]"replaced with your own identifying information. (Don't includethe brackets!)  The text should be enclosed in the appropriatecomment syntax for the file format. We also recommend that afile or class name and description of purpose be included on thesame "printed page" as the copyright notice for easieridentification within third-party archives.Copyright [yyyy] [name of copyright owner]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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.Description: # passive-data-kit-client*This library is **still under construction**. Do not use in stable contexts asthe implementation is likely to change.*This library implements a Python client library for accessing a Passive DataKit (PDK) server and querying data into a local context with all of the relevantlogging and auditing in place server-side. It uses Django queries as aninspiration and functions very similarly.## Usagefrom pdk_client import PDKClient# Create a client object.client = PDKClient(site_url=SITE_URL, username=USERNAME, password=PASSWORD)# Create a data point query objectquery = client.query_data_points(page_size=PAGE_SIZE)# Return the total number of data points on the server.query.count()# Create a new query object that constrains it to a specific data source.new_query = query.filter(source='source-id')new_query.count()# Get the first observed data point for a specific generator.new_query = query.filter(source='source-id', generator_identifier='pdk-device-battery').order_by('created')first_battery_point = new_query[0]# Get the most recently observed point, instead.last_battery_point = new_query[-1]# Iterate over all matching items in query.for point in new_query:print(json.dumps(point, indent=2))# Get the data points for a specific generator, excluding specific source.exclude_query = query.filter(generator_identifier='pdk-device-battery').exclude(source='source-id').order_by('created')## NotesBehind the scenes, this library obtains a time-limited token for querying thePDK server on client creation. Parameters:* `site_url`: URL prefix of the PDK installation. (Example: `https://mysite/data/`)* `username`: Username of authorized PDK user.* `password`: Password of authorized PDK user.Upon fetching the authentication token, the library discards the password forthe remainder of operations, using the token instead. The state of the tokenmay be checked while in use:from pdk_client import PDKClient# Create a client object.client = PDKClient(site_url=SITE_URL, username=USERNAME, password=PASSWORD)# Returns True if the token has expired and a new client should be created, False otherwise.is_expired = client.expired()# Returns datetime.datetime object encoding the expiration date.when_expires = client.expires()# Returns True if the client is authorized to communicate with the server, False otherwise.# May change when the token expires.is_connected = client.connected()When a query object is obtained, the `page_size` parameter may be passed tocontrol the number and size of queries:query = client.query_data_points(page_size=PAGE_SIZE)The library uses paging internally to provide a Python list-like interface foraccessing the data from the server. Since the size of the available data mayexceed memory and bandwidth resources, this allows the necessary work to bedecomposed into workable chunks. Internally, the library also adds anadditional constraint where the data returned will be the data present on theserver at the time of the `PDKClient.query_data_points` call, eliminatingany unexpected behavior where data may be added to the server while the queryis in use.When constraining the query using `filter` or `excludes` functions, thesefunctions are mapped onto their Django equivalents on the PDK server. Argumentson corresponding server `Data Point` objects are supported, as well as anyspecial arguments supported by the remote server, such as [JSONField queries](https://docs.djangoproject.com/en/1.11/ref/contrib/postgres/fields/#querying-jsonfield)on modern Postgres servers:query.filter(properties__application__icontains='youtube').count()## InstallationThe package is intended to be installed with `pip`:pip install git+https://github.com/audaciouscode/PassiveDataKit-Client-Python.gitWhen the library reaches maturity, it will be made available on PyPi as`passive-data-kit-client`.## Major Outstanding ItemsThe following items are on the roadmap for support:* Support for querying other Passive Data Kit types: data sources, alerts, exports.* Support for [Q-object](https://docs.djangoproject.com/en/1.11/topics/db/queries/#complex-lookups-with-q-objects) equivalents, supporting more flexible Boolean parameters.* Support for renewing tokens.* Full support for [slices](https://www.w3schools.com/python/ref_func_slice.asp) in querys.Currently items may be accessed by index, but not range.If you encounter any bugs or other issues, please [add an issue](https://github.com/audaciouscode/PassiveDataKit-Client-Python/issues).Platform: UNKNOWN