docs: fixes the python-sdk docs import statement

[harshsbhat]

What does this PR do?

Fixes #2634

Fixes the import statement in the docs for Python SDK from:

from unkey import Unkey

to

from unkey_py import Unkey

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

• Test A
• Test B

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

• Documentation
  • Updated import statements for the Unkey class across multiple service documentation sections to reflect the new module path from unkey_py import Unkey.
  • Ensured all examples, parameters, responses, and error handling sections remain unchanged, preserving functionality and usage integrity.

[changeset-bot]

⚠️ No Changeset found

Latest commit: db5e42a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request involve updating the import statement for the Unkey class across multiple documentation files. The import path has been modified from from unkey import Unkey to from unkey_py import Unkey in various sections, including examples for API methods related to services like keys, identities, permissions, migrations, and ratelimits. No alterations were made to the parameters, responses, or error handling in the documentation, ensuring the overall structure and functionality remain unchanged.

Changes

File Path	Change Summary
apps/docs/libraries/py/services/apis.mdx	Updated import from from unkey import Unkey to from unkey_py import Unkey.
apps/docs/libraries/py/services/identities.mdx	Updated import from from unkey import Unkey to from unkey_py import Unkey.
apps/docs/libraries/py/services/keys.mdx	Updated import from from unkey import Unkey to from unkey_py import Unkey.
apps/docs/libraries/py/services/migrations.mdx	Updated import from from unkey import Unkey to from unkey_py import Unkey.
apps/docs/libraries/py/services/permissions.mdx	Updated import from from unkey import Unkey to from unkey_py import Unkey.
apps/docs/libraries/py/services/ratelimits.mdx	Updated import from from unkey import Unkey to from unkey_py import Unkey.

Assessment against linked issues

Objective	Addressed	Explanation
Update incorrect imports in documentation (#2634)	✅

Possibly related PRs

• docs: Fixes a few typos in the docs from revoke to modify / retrieve #2212: This PR addresses changes in the documentation related to the keyId parameter, clarifying its purpose from revoking to modifying or retrieving keys, which aligns with the overall theme of updating import statements for the Unkey class in the main PR.
• docs: getVerifications instead of get #2329: This PR corrects the documentation for the getVerifications method, ensuring accurate references to the method used for retrieving verification data, which is relevant to the changes in the import statements for the Unkey class in the main PR.

Suggested labels

Documentation, 🕹️ oss.gg, :joystick: 150 points, hacktoberfest

Suggested reviewers

• mcstepp
• perkinsjr
• MichaelUnkey
• chronark

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 06cf362 and db5e42a.

📒 Files selected for processing (6)

• apps/docs/libraries/py/services/apis.mdx (5 hunks)
• apps/docs/libraries/py/services/identities.mdx (5 hunks)
• apps/docs/libraries/py/services/keys.mdx (14 hunks)
• apps/docs/libraries/py/services/migrations.mdx (2 hunks)
• apps/docs/libraries/py/services/permissions.mdx (8 hunks)
• apps/docs/libraries/py/services/ratelimits.mdx (1 hunks)

✅ Files skipped from review due to trivial changes (6)

• apps/docs/libraries/py/services/apis.mdx
• apps/docs/libraries/py/services/identities.mdx
• apps/docs/libraries/py/services/keys.mdx
• apps/docs/libraries/py/services/migrations.mdx
• apps/docs/libraries/py/services/permissions.mdx
• apps/docs/libraries/py/services/ratelimits.mdx

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 5, 2024 8:39pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 5, 2024 8:39pm

[vercel]

@harshsbhat is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[mcstepp]

👍