Skip to content

Rename wrapper to RavyAPI.py #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 9, 2024
Merged

Rename wrapper to RavyAPI.py #356

merged 1 commit into from
Aug 9, 2024

Conversation

GoogolGenius
Copy link
Owner

@GoogolGenius GoogolGenius commented Aug 9, 2024

Summary by Sourcery

Rename the API wrapper from 'plane' to 'ravyapi' throughout the codebase, including all references in code, documentation, and comments.

Enhancements:

  • Rename all instances of 'plane' to 'ravyapi' across the codebase for consistency with the new naming convention.

Documentation:

  • Update documentation to reflect the renaming from 'plane' to 'ravyapi', including usage examples and error handling.

Copy link
Contributor

sourcery-ai bot commented Aug 9, 2024

Reviewer's Guide by Sourcery

This pull request renames the project from 'Plane' to 'RavyAPI.py' and updates all relevant import paths, docstrings, and documentation to reflect this change. Additionally, the copyright notice has been updated from 'GoogleGenius' to 'GoogolGenius'.

File-Level Changes

Files Changes
ravyapi/api/models/users.py
ravyapi/api/endpoints/users.py
ravyapi/api/endpoints/urls.py
ravyapi/api/models/guilds.py
ravyapi/api/endpoints/avatars.py
ravyapi/api/endpoints/guilds.py
ravyapi/api/endpoints/ksoft.py
ravyapi/api/endpoints/tokens.py
ravyapi/api/models/urls.py
ravyapi/api/models/avatars.py
ravyapi/api/models/ksoft.py
ravyapi/api/models/tokens.py
Updated import paths and docstrings to reflect the new module path 'ravyapi'.
README.md
docs/getting_started.md
docs/index.md
mkdocs.yml
docs/reference/api/endpoints/avatars.md
docs/reference/api/endpoints/guilds.md
docs/reference/api/endpoints/ksoft.md
docs/reference/api/endpoints/tokens.md
docs/reference/api/endpoints/urls.md
docs/reference/api/endpoints/users.md
docs/reference/api/errors.md
docs/reference/api/models/avatars.md
docs/reference/api/models/generic/ban_entry.md
docs/reference/api/models/generic/trust.md
docs/reference/api/models/guilds.md
docs/reference/api/models/ksoft.md
docs/reference/api/models/tokens.md
docs/reference/api/models/urls.md
docs/reference/api/models/users.md
docs/reference/client.md
Updated documentation to reflect the new project name 'RavyAPI.py' and the new repository URL.
ravyapi/http.py
ravyapi/client.py
ravyapi/utils.py
Updated logger names and import paths to reflect the new module path 'ravyapi'.
ravyapi/__init__.py
ravyapi/_about.py
ravyapi/api/__init__.py
ravyapi/api/endpoints/__init__.py
ravyapi/api/errors.py
ravyapi/api/models/__init__.py
ravyapi/api/models/generic/__init__.py
ravyapi/api/models/generic/ban_entry.py
ravyapi/api/models/generic/trust.py
ravyapi/api/paths.py
tests/__init__.py
Updated copyright notice from 'GoogleGenius' to 'GoogolGenius'.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @GoogolGenius - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.



async def main() -> None:
# Construct a plane client object
client = plane.Client("token") # Replace "token" with your API key
# Construct a ravyapi client object
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (documentation): Inconsistent capitalization in comment.

The term 'ravyapi' should be capitalized as 'RavyAPI' to maintain consistency with the rest of the documentation.

Suggested change
# Construct a ravyapi client object
# Construct a RavyAPI client object

@GoogolGenius GoogolGenius merged commit 8005ab7 into main Aug 9, 2024
15 of 16 checks passed
@GoogolGenius GoogolGenius deleted the test/rename branch August 9, 2024 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant