Standard-Labs / real-intent

Python SDK and abstracted interface for BigDBM's API.
0 stars 0 forks source link

Rename package to `real_intent` #74

Closed preritdas closed 2 months ago

preritdas commented 2 months ago

No more bigdbm-python or from bigdbm import ... in favor of real-intent.

Adjust imports in client code.

from real_intent.client ...
from real_intent.analyze ...
from real_intent.deliver ...
...

This is an extremely breaking change. Bump package upgrade to a major version and update client code accordingly.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The overall change involves a comprehensive rebranding of the project from "BigDBM" to "Real Intent." This includes updates to Docker configurations, project metadata, and import paths across various modules and tests. The modifications reflect a shift in the project's identity while maintaining its core functionalities.

Changes

Files Change Summary
.github/workflows/tests.yaml Changed Docker image name from bigdbm-python to real-intent in build and run commands.
README.md Updated SDK title from "BigDBM Python SDK" to "Real Intent SDK" and expanded description for clarity.
pyproject.toml Renamed project from "bigdbm" to "real-intent," updated description, repository URL, and package data.
real_intent/__init__.py Introduced as a client package for Real Intent operations, importing key components for API interaction.
real_intent/analyze/__init__.py New module for generating insights based on lead data, importing relevant classes.
real_intent/analyze/base.py Updated import paths from bigdbm to real_intent for dependencies.
real_intent/analyze/insights/__init__.py Refactored imports to source from real_intent, indicating module restructuring.
real_intent/client.py Changed imports from bigdbm to real_intent, updating dependencies for the BigDBMClient class.
real_intent/deliver/... Updated import paths for various deliver modules from bigdbm to real_intent.
real_intent/process/... Modified import statements to reflect new namespace, maintaining class functionality.
real_intent/validate/... Adjusted imports for validation modules to point to real_intent, ensuring consistent namespace usage.
tests/... Updated all test files to import from the new real_intent namespace, ensuring tests align with new structure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RealIntentAPI
    participant Docker
    User->>Docker: Build real-intent image
    Docker->>RealIntentAPI: Run tests using real-intent image
    RealIntentAPI-->>User: Return test results

🐰 In the meadow, I hop with glee,
A new name brings joy, can't you see?
Real Intent blooms, fresh and bright,
With changes that make everything right!
Let's celebrate with a joyful cheer,
For a brighter future, oh so near! 🌼


Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **Anthropic `claude-3-5-sonnet` for code reviews**: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues on the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838).