-
Notifications
You must be signed in to change notification settings - Fork 0
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
Refactor paths #357
Conversation
Reviewer's Guide by SourceryThis 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
Tips
|
There was a problem hiding this 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
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 |
There was a problem hiding this comment.
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`. |
There was a problem hiding this comment.
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.
…into paths/refactor
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:
Documentation:
Chores: