caredaily 1.0.2__tar.gz

caredaily-1.0.2/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. 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 by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright 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 Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable 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, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this 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 licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks 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 grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the 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 this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification 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 at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

caredaily-1.0.2/PKG-INFO

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: caredaily
+Version: 1.0.2
+Summary: CLI and API interface for CareDaily applications.
+Author-email: Destry Teeter <destry@caredaily.ai>
+License-Expression: Apache-2.0
+Project-URL: homepage, https://github.com/peoplepower/python-core
+Project-URL: documentation, https://app.peoplepowerco.com/cloud/apidocs/cloud.html
+Keywords: caredaily,smart-home,iot,api-client,sdk,cli,home-automation,caregiving,monitoring,devices
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: click
+Requires-Dist: python-dotenv
+Requires-Dist: tabulate
+Requires-Dist: requests>=2.32.3
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pyyaml; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Provides-Extra: websockets
+Requires-Dist: websockets>=12.0; extra == "websockets"
+Provides-Extra: rsa
+Requires-Dist: cryptography; extra == "rsa"
+Dynamic: license-file
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# CareDaily
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/license/apache-2-0)
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/peoplepower/python-core?sort=semver)](https://github.com/peoplepower/python-core/tree/latest)
+[![Documentation](https://img.shields.io/badge/docs-apidocs-blue.svg)](https://app.peoplepowerco.com/cloud/apidocs/html/cloud.html)
+
+Python SDK and CLI tool for interacting with the CareDaily API platform.
+
+[**CareDaily**](#caredaily) |
+[**Just Watch It Work**](#just-watch-it-work) |
+[**Getting Started**](#getting-started) |
+[**Explore the docs**](#explore-the-docs) |
+[**Sign Up**](https://app.caredaily.ai/signup)
+
+## About
+
+The CareDaily Python SDK provides a comprehensive interface to the CareDaily cloud platform (powered by People Power Company). It offers both programmatic access through Python classes and a command-line interface for managing smart home devices, user accounts, locations, and AI-powered services.
+
+This package enables developers to:
+- Build applications that integrate with CareDaily services
+- Manage user authentication and authorization
+- Control and monitor IoT devices
+- Access AI and machine learning capabilities
+- Manage administrative tasks and analytics
+
+## Just watch it work
+
+```bash
+# Install the package
+pip install caredaily
+
+# Initialize your configuration
+caredaily configure init
+
+# Test connectivity
+caredaily ping
+```
+
+## Getting Started
+
+### Installation
+
+Install from PyPI (when published):
+```bash
+pip install caredaily
+```
+
+Or install from source:
+```bash
+git clone https://github.com/peoplepower/python-core.git
+cd python-core
+pip install -e ".[dev]"
+```
+
+### Configuration
+
+Before using the SDK or CLI, you need to configure your credentials:
+
+```bash
+# Initialize configuration (creates ~/.caredaily/config and ~/.caredaily/credentials)
+caredaily configure init
+
+# Set up a profile interactively
+caredaily configure interactive --profile myprofile
+
+# Or use environment variable to specify profile
+export CAREDAILY_PROFILE=myprofile
+```
+
+Your configuration files will be stored in `~/.caredaily/`:
+- `config`: Hostname, SSL settings, proxy configuration
+- `credentials`: API keys (kept separate for security)
+
+### Using the CLI
+
+```bash
+# Check cloud connectivity
+caredaily cloud-connectivity --check-availability
+
+# Login with username and password
+caredaily login --username myuser --password mypass
+
+# Get cloud version
+caredaily cloud-connectivity --version
+
+# Use a specific profile
+caredaily --profile production ping
+```
+
+### Using the SDK
+
+```python
+from caredaily import CareDaily, Authentication, CloudConnectivity
+
+# Initialize with default profile
+client = CareDaily()
+
+# Or use a specific profile
+client = CareDaily(profile="production")
+
+# Check cloud connectivity
+result = client.app_api(CloudConnectivity).check_availability()
+print(result.data)
+
+# Login with credentials
+auth_result = client.app_api(Authentication).login_by_username(
+    username="myuser",
+    password="mypass"
+)
+print(auth_result.data)
+
+# Access different API types
+from caredaily import Locations, Devices
+
+# Get user information
+user_information = client.app_api(UserAccounts).get_user_information()
+
+# Get devices
+devices = client.app_api(Devices).get_devices()
+```
+
+### API Examples
+
+#### Working with Locations
+```python
+from caredaily import CareDaily, Locations
+
+client = CareDaily()
+locations_api = client.app_api(Locations)
+
+# Get all locations for the user
+result = locations_api.get_user_information()
+for location in result.data.get('locations', []):
+    print(f"Location: {location['name']}")
+```
+
+#### Working with Devices
+```python
+from caredaily import CareDaily, Devices
+
+client = CareDaily()
+devices_api = client.app_api(Devices)
+
+# Get all devices
+result = devices_api.get_devices()
+for device in result.data.get('devices', []):
+    print(f"Device: {device['id']} - {device['type']}")
+```
+
+#### Admin Operations
+```python
+from caredaily import CareDaily, Users, Organizations
+
+client = CareDaily()  # Must use admin API key
+
+# Get organization users
+users_api = client.admin_api(Users)
+result = users_api.get_users(organizationId=123)
+
+# Get organization details
+orgs_api = client.admin_api(Organizations)
+result = orgs_api.get_organization(organizationId=123)
+```
+
+### Development
+
+For development setup and testing:
+
+```bash
+# Install with development dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run tests with coverage
+pytest --cov=caredaily --cov-report=html
+
+# Run linter
+ruff check src/
+
+# Format code
+ruff format src/
+```
+
+## Explore the Docs
+
+CareDaily provides several API documentation resources to help you build and integrate with the platform:
+
+- **[Cloud API Docs](https://app.peoplepowerco.com/cloud/apidocs/cloud.html)**
+Comprehensive reference for the main CareDaily cloud API, including endpoints for device management, user accounts, locations, and core platform services.
+- **[Admin API Docs](https://app.peoplepowerco.com/cloud/apidocs/admin.html)**
+Documentation for administrative APIs, covering organization management, user administration, analytics, and advanced configuration options for enterprise use.
+- **[Bots API Docs](https://app.peoplepowerco.com/cloud/apidocs/bots.html)**
+Details on the Bots API, which enables automation, custom bot creation, and integration with CareDaily's AI-powered services for smart home and IoT workflows.
+
+## Get Involved
+
+- Ask and answer questions on [StackOverflow](https://stackoverflow.com/questions/tagged/caredaily-python) using the **caredaily-python** tag
+
+- Help find and fix issues by [**reporting bugs**](https://github.com/peoplepower/python-core/issues/new?labels=bug&template=bug-report---.md).
+- Have a new idea?  Have a suggestion? [**Request a feature**](https://github.com/peoplepower/python-core/issues/new?labels=enhancement&template=feature-request---.md) to get our attention.
+
+## Contributor Guide
+
+Interested in contributing? Check out our
+[CONTRIBUTING.md](https://github.com/peoplepower/python-core/blob/master/CONTRIBUTING.md)
+to find resources around contributing along with a detailed guide on
+how to set up a development environment.
+
+## Activity
+
+<a href="https://next.ossinsight.io/widgets/official/compose-org-active-contributors?period=past_12_months&activity=active&owner_id=113403165" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?owner_id=113403165&period=past_12_months&activity=active&image_size=2x3&color_scheme=dark" width="273" height="auto">
+    <img alt="Active participants of pingcap - past 28 days" src="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?owner_id=113403165&period=past_12_months&activity=active&image_size=2x3&color_scheme=light" width="273" height="auto">
+  </picture>
+</a>
+
+<!-- Made with [OSS Insight](https://ossinsight.io/) -->