Skip to content

Refactor paths #357

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 5 commits into from
Aug 9, 2024
Merged

Refactor paths #357

merged 5 commits into from
Aug 9, 2024

Conversation

GoogolGenius
Copy link
Owner

@GoogolGenius GoogolGenius commented Aug 9, 2024

Summary by Sourcery

Refactor routing paths to use a new BasePath class, update documentation and import statements to reflect the renaming of the package from 'plane' to 'ravyapi', and correct copyright notices.

Enhancements:

  • Introduce a new BasePath class to serve as a base class for routing paths, consolidating common attributes and methods.
  • Refactor existing path classes (Avatars, Guilds, KSoft, Tokens, URLs, Users) to inherit from the new BasePath class, reducing code duplication.
  • Update the slots attribute in the Paths class to include all endpoint attributes.

Documentation:

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

Chores:

  • Correct copyright notices from 'GoogleGenius' to 'GoogolGenius' across multiple files.
  • Update import statements and references from 'plane' to 'ravyapi' throughout the codebase.

Copy link
Contributor

sourcery-ai bot commented Aug 9, 2024

Reviewer's Guide by Sourcery

This pull request refactors the project by renaming the project from 'Plane' to 'RavyAPI.py' and updating all relevant import paths and copyright notices. Additionally, it introduces a new BasePath class for routing paths and refactors existing path classes to inherit from this new base class.

File-Level Changes

Files Changes
ravyapi/api/paths.py
ravyapi/api/models/users.py
ravyapi/api/endpoints/users.py
ravyapi/api/endpoints/urls.py
ravyapi/api/models/guilds.py
ravyapi/http.py
ravyapi/api/endpoints/avatars.py
ravyapi/api/endpoints/guilds.py
ravyapi/api/endpoints/ksoft.py
ravyapi/api/endpoints/tokens.py
ravyapi/client.py
ravyapi/utils.py
ravyapi/api/models/urls.py
ravyapi/api/models/avatars.py
ravyapi/api/models/ksoft.py
ravyapi/api/models/tokens.py
ravyapi/const.py
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
tests/__init__.py
Updated copyright notices from 'GoogleGenius' to 'GoogolGenius' and changed import paths from 'plane' to 'ravyapi'.
docs/getting_started.md
README.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 new project name 'RavyAPI.py' and changed import paths from 'plane' to 'ravyapi'.

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 - here's some feedback:

Overall Comments:

  • This is a comprehensive and well-executed rename and refactor. The introduction of the BasePath class in paths.py is a nice improvement for code maintainability.
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: 2 issues 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.

README.md Outdated
@@ -19,7 +19,7 @@ A simple and dynamic asynchronous Python wrapper for the Ravy API.
- Not yet available on PyPI

```bash
python3 -m pip install git+https://github.com/GoogleGenius/plane
python3 -m pip install git+https://github.com/GoogolGenius/RavyAPI.py
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (documentation): Correct the GitHub username from 'GoogleGenius' to 'GoogolGenius'.

Ensure that the username is consistently updated throughout the documentation.

docs/index.md Outdated
@@ -47,4 +47,4 @@ asyncio.run(main())

Feel free to create pull requests and issues. Just be civil, kind, and respectful.

This is my first library, so if you have any suggestions or questions, please let me know! Reach out via GitHub Issues or Discord `@googlegenius`.
This is my first library, so if you have any suggestions or questions, please let me know! Reach out via GitHub Issues or Discord `@googolgenius`.
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (documentation): Correct the GitHub username from 'GoogleGenius' to 'GoogolGenius'.

Ensure that the username is consistently updated throughout the documentation.

@GoogolGenius GoogolGenius enabled auto-merge (squash) August 9, 2024 05:36
@GoogolGenius GoogolGenius mentioned this pull request Aug 9, 2024
@GoogolGenius GoogolGenius disabled auto-merge August 9, 2024 05:41
@GoogolGenius GoogolGenius merged commit 27dab5a into main Aug 9, 2024
14 checks passed
@GoogolGenius GoogolGenius deleted the paths/refactor branch August 9, 2024 05:41
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