bloomy-python 0.12.1__py3-none-any.whl

bloomy/operations/users.py

@@ -0,0 +1,154 @@
+"""User operations for the Bloomy SDK."""
+
+from __future__ import annotations
+
+from ..models import DirectReport, Position, UserDetails, UserListItem, UserSearchResult
+from ..utils.base_operations import BaseOperations
+
+
+class UserOperations(BaseOperations):
+    """Class to handle all operations related to users."""
+
+    def details(
+        self,
+        user_id: int | None = None,
+        direct_reports: bool = False,
+        positions: bool = False,
+        all: bool = False,
+    ) -> UserDetails:
+        """Retrieve details of a specific user.
+
+        Args:
+            user_id: The ID of the user (default: the current user ID)
+            direct_reports: Whether to include direct reports (default: False)
+            positions: Whether to include positions (default: False)
+            all: Whether to include both direct reports and positions (default: False)
+
+        Returns:
+            A UserDetails model containing user details
+        """
+        if user_id is None:
+            user_id = self.user_id
+
+        response = self._client.get(f"users/{user_id}")
+        response.raise_for_status()
+        data = response.json()
+
+        user_details_dict = {
+            "id": data["Id"],
+            "name": data["Name"],
+            "image_url": data["ImageUrl"],
+        }
+
+        if direct_reports or all:
+            user_details_dict["direct_reports"] = self.direct_reports(user_id)
+
+        if positions or all:
+            user_details_dict["positions"] = self.positions(user_id)
+
+        return UserDetails(**user_details_dict)
+
+    def direct_reports(self, user_id: int | None = None) -> list[DirectReport]:
+        """Retrieve direct reports of a specific user.
+
+        Args:
+            user_id: The ID of the user (default: the current user ID)
+
+        Returns:
+            A list of DirectReport models containing direct report details
+        """
+        if user_id is None:
+            user_id = self.user_id
+
+        response = self._client.get(f"users/{user_id}/directreports")
+        response.raise_for_status()
+        data = response.json()
+
+        return [
+            DirectReport(
+                name=report["Name"],
+                id=report["Id"],
+                image_url=report["ImageUrl"],
+            )
+            for report in data
+        ]
+
+    def positions(self, user_id: int | None = None) -> list[Position]:
+        """Retrieve positions of a specific user.
+
+        Args:
+            user_id: The ID of the user (default: the current user ID)
+
+        Returns:
+            A list of Position models containing position details
+        """
+        if user_id is None:
+            user_id = self.user_id
+
+        response = self._client.get(f"users/{user_id}/seats")
+        response.raise_for_status()
+        data = response.json()
+
+        return [
+            Position(
+                name=position["Group"]["Position"]["Name"],
+                id=position["Group"]["Position"]["Id"],
+            )
+            for position in data
+        ]
+
+    def search(self, term: str) -> list[UserSearchResult]:
+        """Search for users based on a search term.
+
+        Args:
+            term: The search term
+
+        Returns:
+            A list of UserSearchResult models containing search results
+        """
+        response = self._client.get("search/user", params={"term": term})
+        response.raise_for_status()
+        data = response.json()
+
+        return [
+            UserSearchResult(
+                id=user["Id"],
+                name=user["Name"],
+                description=user["Description"],
+                email=user["Email"],
+                organization_id=user["OrganizationId"],
+                image_url=user["ImageUrl"],
+            )
+            for user in data
+        ]
+
+    def all(self, include_placeholders: bool = False) -> list[UserListItem]:
+        """Retrieve all users in the system.
+
+        Args:
+            include_placeholders: Whether to include placeholder users (default: False)
+
+        Returns:
+            A list of UserListItem models containing user details
+        """
+        response = self._client.get("search/all", params={"term": "%"})
+        response.raise_for_status()
+        users = response.json()
+
+        filtered_users = [
+            user
+            for user in users
+            if user["ResultType"] == "User"
+            and (include_placeholders or user["ImageUrl"] != "/i/userplaceholder")
+        ]
+
+        return [
+            UserListItem(
+                id=user["Id"],
+                name=user["Name"],
+                email=user["Email"],
+                position=user["Description"],
+                image_url=user["ImageUrl"],
+            )
+            for user in filtered_users
+        ]

bloomy/utils/__init__.py

@@ -0,0 +1 @@
+"""Utility modules for the Bloomy SDK."""

bloomy/utils/base_operations.py

@@ -0,0 +1,43 @@
+"""Base class for API operations."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    import httpx
+
+
+class BaseOperations:
+    """Base class for all API operation classes."""
+
+    def __init__(self, client: httpx.Client) -> None:
+        """Initialize the operations class.
+
+        Args:
+            client: The HTTP client to use for API requests.
+        """
+        self._client = client
+        self._user_id: int | None = None
+
+    @property
+    def user_id(self) -> int:
+        """Get the current user's ID, fetching it if needed.
+
+        Returns:
+            The user ID of the authenticated user.
+        """
+        if self._user_id is None:
+            self._user_id = self._get_default_user_id()
+        return self._user_id
+
+    def _get_default_user_id(self) -> int:
+        """Fetch the default user ID from the API.
+
+        Returns:
+            The user ID of the authenticated user.
+        """
+        response = self._client.get("users/mine")
+        response.raise_for_status()
+        data = response.json()
+        return data["Id"]

bloomy_python-0.12.1.dist-info/METADATA

@@ -0,0 +1,253 @@
+Metadata-Version: 2.4
+Name: bloomy-python
+Version: 0.12.1
+Summary: Python SDK for Bloom Growth API
+Author-email: Franccesco Orozco <franccesco@codingdose.info>
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: dev
+Requires-Dist: pyright>=1.1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.5.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Bloomy - Python SDK for Bloom Growth API
+
+![Python Version](https://img.shields.io/badge/python-3.12+-blue.svg)
+[![Deploy Documentation](https://github.com/franccesco/bloomy-python/actions/workflows/docs.yml/badge.svg)](https://github.com/franccesco/bloomy-python/actions/workflows/docs.yml)
+
+A Python SDK for interacting with the Bloom Growth API, providing easy access to users, meetings, todos, goals, scorecards, issues, and headlines.
+
+## Installation
+
+```bash
+pip install bloomy-python
+```
+
+## Quick Start
+
+```python
+from bloomy import Client
+
+# Initialize the client with your API key
+client = Client(api_key="your-api-key-here")
+
+# Or use environment variable BG_API_KEY
+client = Client()
+
+# Or configure API key with username and password
+from bloomy import Configuration
+
+config = Configuration()
+config.configure_api_key("username", "password", store_key=True)
+client = Client()
+```
+
+## Features
+
+### Users
+
+```python
+# Get current user details
+user = client.user.details()
+
+# Get user with direct reports and positions
+user = client.user.details(user_id=123, all=True)
+
+# Search users
+results = client.user.search("john")
+
+# Get all users
+users = client.user.all()
+```
+
+### Meetings
+
+```python
+# List meetings
+meetings = client.meeting.list()
+
+# Get meeting details
+meeting = client.meeting.details(meeting_id=123)
+
+# Create a meeting
+new_meeting = client.meeting.create(
+    title="Weekly Team Meeting",
+    attendees=[456, 789]
+)
+
+# Delete a meeting
+client.meeting.delete(meeting_id=123)
+```
+
+### Todos
+
+```python
+# List todos for current user
+todos = client.todo.list()
+
+# Create a todo
+new_todo = client.todo.create(
+    title="Complete project proposal",
+    meeting_id=123,
+    due_date="2024-12-31"
+)
+
+# Complete a todo
+client.todo.complete(todo_id=456)
+
+# Update a todo
+client.todo.update(
+    todo_id=456,
+    title="Updated title",
+    due_date="2024-12-25"
+)
+```
+
+### Goals (Rocks)
+
+```python
+# List goals
+goals = client.goal.list()
+
+# Create a goal
+new_goal = client.goal.create(
+    title="Increase sales by 20%",
+    meeting_id=123,
+    user_id=456
+)
+
+# Update goal status
+client.goal.update(goal_id=789, status="on")  # on, off, or complete
+
+# Archive a goal
+client.goal.archive(goal_id=789)
+```
+
+### Scorecard
+
+```python
+# Get current week
+week = client.scorecard.current_week()
+
+# List scorecard items
+scorecards = client.scorecard.list(meeting_id=123)
+
+# Update a score
+client.scorecard.score(measurable_id=456, score=95.5)
+```
+
+### Issues
+
+```python
+# List issues
+issues = client.issue.list()
+
+# Create an issue
+new_issue = client.issue.create(
+    meeting_id=123,
+    title="Server performance degradation"
+)
+
+# Solve an issue
+client.issue.solve(issue_id=456)
+```
+
+### Headlines
+
+```python
+# List headlines
+headlines = client.headline.list(meeting_id=123)
+
+# Create a headline
+new_headline = client.headline.create(
+    meeting_id=123,
+    title="Product launch successful",
+    notes="Exceeded targets by 15%"
+)
+
+# Update a headline
+client.headline.update(headline_id=456, title="Updated headline")
+
+# Delete a headline
+client.headline.delete(headline_id=456)
+```
+
+## Configuration
+
+The SDK supports multiple ways to provide your API key:
+
+1. **Direct initialization**: Pass the API key when creating the client
+2. **Environment variable**: Set `BG_API_KEY` in your environment
+3. **Configuration file**: Store the API key in `~/.bloomy/config.yaml`
+4. **Dynamic configuration**: Use username/password to fetch and store the API key
+
+```python
+# Using configuration file
+config = Configuration()
+config.configure_api_key("username", "password", store_key=True)
+```
+
+## Error Handling
+
+The SDK raises specific exceptions for different error scenarios:
+
+```python
+from bloomy.exceptions import BloomyError, ConfigurationError, AuthenticationError, APIError
+
+try:
+    client.user.details()
+except AuthenticationError:
+    print("Invalid API key")
+except APIError as e:
+    print(f"API error: {e.message}, Status: {e.status_code}")
+except BloomyError as e:
+    print(f"General error: {e}")
+```
+
+## Development
+
+This SDK uses:
+- **uv** for package management
+- **ruff** for formatting and linting
+- **pyright** for type checking
+- **pytest** for testing
+
+To set up the development environment:
+
+```bash
+# Install uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Install dependencies
+uv sync --all-extras
+
+# Run tests
+uv run pytest
+
+# Format code
+uv run ruff format .
+
+# Run linting
+uv run ruff check . --fix
+
+# Type checking
+uv run pyright
+```
+
+## Requirements
+
+- Python 3.12+
+- httpx
+- pyyaml
+- pydantic
+
+## License
+
+This project is licensed under the MIT License.

bloomy_python-0.12.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+bloomy/__init__.py,sha256=a-cxyRFonxVlFqgWF8_TzjKmeI-G0M8wHj9Q502pb_Q,1523
+bloomy/client.py,sha256=Mm13Fd21iJjckbb3dsIgyDV6eNgnnGTRJDCi0hI3X2Y,3106
+bloomy/configuration.py,sha256=cX4rsTvNGk9Gc25ppMFMDVMTn7eMin3XzIksoNZ-6aE,4219
+bloomy/exceptions.py,sha256=UfsY8ew2xlW-yvckzIHVYe1xYmas2LHdushQyDe3uQs,577
+bloomy/models.py,sha256=QYmW6oiINf5nYgaQkNcSdxJzBAigcV4tLQ7uHpkXTh8,9540
+bloomy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bloomy/operations/__init__.py,sha256=yCZ6PD_EIYpEKEC8_SKFvTyaE7D3pUc3nyidkNoKNSU,487
+bloomy/operations/goals.py,sha256=TjiRpBFFIJdwUou7rfeSWshnlYRHxDoO3qnug-zCeAM,8535
+bloomy/operations/headlines.py,sha256=J9R5E7HVH-Tc6DRWg-qqv-D2LHIwH_5sh3L0vgv4_Pw,6032
+bloomy/operations/issues.py,sha256=MmPLD_GkY9dAUvxymtVGlZrn3PYsT-Y8L61v_KeMK80,5745
+bloomy/operations/meetings.py,sha256=yyX9IWtQf9pNrSll--4yxLRs4HACrEk-cd7drFCWJcE,9816
+bloomy/operations/scorecard.py,sha256=7v2kffJoTE2iVJGPU9jXh4vK4rNT42SU89JitVg4dn8,5067
+bloomy/operations/todos.py,sha256=kZyDYHRK4wZwEKqZZ1tZknv4S6adQx6shUalhi3Xogk,6724
+bloomy/operations/users.py,sha256=lU2eDVLOiTiBqGilsV-Hrv4-M3gArhUp6qUyr1Mq6q4,4742
+bloomy/utils/__init__.py,sha256=7nefIecEH5MHXusORshtHbhl7YZUiPFoLiDAAMvtu2U,42
+bloomy/utils/base_operations.py,sha256=l14mYgyf4oj_WrMi0xhi8QdwaFTI6_9Oew6NvyIwCOQ,1102
+bloomy_python-0.12.1.dist-info/METADATA,sha256=k5syUF5iyskl8WjRW4ZvwKwaEfuTxEu2GDyb8VkCJAU,5232
+bloomy_python-0.12.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bloomy_python-0.12.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+bloomy_python-0.12.1.dist-info/RECORD,,

bloomy_python-0.12.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

bloomy_python-0.12.1.dist-info/licenses/LICENSE

@@ -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.