Open winstonsung opened 2 weeks ago
The changes in this pull request introduce a new JSON structure for localization in the zh-hant.json
file, which was previously empty. This file now includes a metadata section with authors and various key-value pairs for translations related to course functionalities. Additionally, a docstring has been added to the website_flask.py
file, providing an entry point description for the SCAICT store website using Flask. The pyproject.toml
, requirements_dev.txt
, and requirements.txt
files have also been updated to reflect new stable versions of dependencies. Other files were modified to enhance clarity and functionality.
File | Change Summary |
---|---|
src/scaict_uwu/i18n/course/zh-hant.json |
Introduced a new JSON structure with metadata and multiple key-value pairs for course-related translations. |
src/scaict_uwu/website_flask.py |
Added a docstring describing the entry point for the Flask website, with a TODO note for further documentation. |
pyproject.toml |
Updated project version from 0.1.9.dev0 to 0.1.9 and modified several dependency versions. |
requirements_dev.txt |
Updated several development dependency versions, including astroid , black , dill , platformdirs , pylint , and pytest . |
requirements.txt |
Updated several dependency versions, including aiohappyeyeballs , aiohttp , certifi , idna , markupsafe , multidict , py-cord , urllib3 , and yarl . |
RELEASE-NOTES-0.1.md |
Added a new file detailing the development history and version changes from 0.1.0 to 0.1.7. |
.env.example |
Added new configuration variables for database and application settings, enhancing organization and readability. |
CONTRIBUTING.md |
Corrected a typographical error in the database naming conventions section and clarified requirements. |
README.md |
Updated badge labels to title case, refined section headers, and improved overall document clarity. |
app.py |
Enhanced configuration and functionality by integrating environment variables and restructuring logic. |
cog/api/gift.py |
Introduced a new Gift class for managing Discord API interactions related to sending gifts. |
cog/comment.py |
Made cosmetic changes to comments for clarity in the Comment class methods. |
cog/game.py |
Corrected a comment in the rock_paper_scissors method for clarity. |
docs/abstract_schema_table.json |
Revised JSON schema structure, changing the root type and expanding column data types. |
static/switch-btn.js |
Removed a redundant line in the switchRight function, simplifying the code. |
templates/home.html |
Corrected a comment for clarity in the JavaScript section without impacting functionality. |
test/enumstruct.py |
Introduced a new file defining an enumeration class GiftType for managing gift types. |
In the realm of code where translations gleam,
New words take flight, like a bright, playful dream.
With metadata shining and docstrings in tow,
Our interface dances, ready to glow!
Here's to the changes, both clever and neat,
A purr-fect update, oh, what a treat! 🐾✨
requirements.txt (3)
`6-6`: **Purr-fect security updates! 😺** Good job updating certifi and urllib3! These updates include important security patches to keep your application safe and sound. Also applies to: 21-21 --- `1-23`: **Looking good overall! 🐱** All dependencies are using stable versions, and the incremental updates look reasonable. *\*happy tail swish\** --- `15-15`: **Meow! Watch out for breaking changes in markupsafe! 🐱** The upgrade from markupsafe 2.1.5 to 3.0.2 is a major version bump that might introduce breaking changes. Please ensure your templates and HTML escaping still work as expected. Let me sniff around for potential issues:✅ Verification successful
Let me try another approach to sniff out any potential usage of markupsafe in the codebase. This will help me check both Python files and template files for any markupsafe usage patterns. As a curious cat, I want to be thorough in my investigation! 🐱 --- **Purr-fectly safe to proceed with the markupsafe update! 😺** After my thorough investigation, I found that markupsafe is only listed as a dependency in requirements.txt but isn't directly used in the codebase. It's likely a transitive dependency required by another package. Since there's no direct usage of markupsafe's features in the code, the major version bump shouldn't cause any immediate issues. *Meow tip*: Keep an eye on the packages that depend on markupsafe during testing, but there's no need to block this update! 🐱🏁 Scripts executed
The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Search for markupsafe usage patterns that might be affected rg -l "markupsafe|Markup|escape|soft_unicode" ``` Length of output: 64 --- Script: ```shell #!/bin/bash # Look for Python files that might use markupsafe fd -e py --exec rg -l "from markupsafe|import markupsafe|Markup\.|escape\(" {} \; # Also check for template files that might be affected fd -e html -e jinja -e j2 --exec rg -l "escape|safe" {} \; ``` Length of output: 150pyproject.toml (2)
`8-8`: **Purr-fect version bump! 😺** The version change from "0.1.9.dev0" to "0.1.9" indicates we're ready for a stable release. Meow-velous! --- `33-33`: **Let me sniff these dependency updates... 🐱** All dependency updates look like safe minor version bumps: - py-cord: 2.6.0 → 2.6.1 - black: 24.8.0 → 24.10.0 - pylint: 3.2.6 → 3.3.1 - pytest: 8.3.2 → 8.3.3 Let me check if these versions play nicely together! Also applies to: 39-41✅ Verification successful
Let me verify the actual available versions on PyPI to provide accurate information. --- **Purr-fect news! All these dependency versions are valid and up-to-date! 😺** My whiskers have detected that all the specified versions in pyproject.toml match exactly with the latest available versions on PyPI: - py-cord 2.6.1 ✓ - black 24.10.0 ✓ - pylint 3.3.1 ✓ - pytest 8.3.3 ✓ These are all safe and proper version bumps, and I can confirm they're the latest releases available. No hairballs to worry about here! 🐱🏁 Scripts executed
The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Check if the specified versions exist in PyPI echo "=== Checking PyPI for package versions ===" for pkg in "py-cord==2.6.1" "black==24.10.0" "pylint==3.3.1" "pytest==8.3.3"; do curl -s "https://pypi.org/pypi/${pkg%=*}/json" | jq -r --arg ver "${pkg#*==}" '.releases | has($ver)' done ``` Length of output: 808 --- Script: ```shell #!/bin/bash # Check latest versions of packages on PyPI echo "=== Checking latest versions on PyPI ===" for pkg in "py-cord" "black" "pylint" "pytest"; do echo "Latest versions for $pkg:" curl -s "https://pypi.org/pypi/${pkg}/json" | jq -r '.releases | keys[]' | sort -V | tail -n 5 done # Also check what versions are currently in use echo -e "\n=== Current versions in pyproject.toml ===" cat pyproject.toml | grep -E "py-cord|black|pylint|pytest" ``` Length of output: 1296
anything to do before release?
Nothing to do during upgrade as far as I know.
any plan about migrating code to src
folder, or develop in original path
New team is assigning tasks for uwu, maybe we need to discuss the future plan
Any plan about migrating code to
src
folder, or develop in original path?
The current plan is to migrate code to the src
folder while keeping some entrypoints in the root folder.
There were attempts about using the flat layout, but it turns out to be more complicated than the src layout, thus being reverted.
New team is assigning tasks for uwu, maybe we need to discuss the future plan.
Yeah, of course.
Summary by CodeRabbit
Release Notes
New Features
Gift
class for managing gift sending via Discord.Documentation
RELEASE-NOTES-0.1.md
to detail development history and version changes..env.example
file with new configuration variables for database and application settings.README.md
file.CONTRIBUTING.md
file by correcting typographical errors and clarifying coding conventions.Chores