Add spell lookup feature using spells.json and fix savename option - #9
Open
vkaraujo wants to merge 1 commit into
Open
Add spell lookup feature using spells.json and fix savename option#9vkaraujo wants to merge 1 commit into
vkaraujo wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hey, I found your project on tiktok and really loved it. I don't usually code in python, but its something i have been wanting to practice and when I saw the opportunity to contribute to something so cool I grabed it.
Thanks for the awesome project! Happy to discuss any adjustments you might want.
Summary
--lookupCLI option to search for spells insidespells.json.--savenamebug (argument was parsed but not assigned), allowing users to customize output filenames.services/spell_lookup_service.pyto keepwriter.pyclean and modular.Reasoning
This PR implements issue #6 and improves code structure. It also prepares the project for future expansion by moving new logic into service classes.
Notes
Future Suggestions (Optional Enhancements)
While working on this contribution, I noticed a few areas that could improve user experience and project organization further:
Normalize user input for spell generation (e.g., case-insensitive matching, auto-trimming spaces).
Right now, users must type exactly what's in the .txt files (case-sensitive, exact spaces). Improving this would make the CLI much more forgiving and user-friendly.
Automatically save generated plots into a
Generated/Plots/folder instead of the project root.Add a
requirements.txtfile to simplify installing dependencies like numpy, matplotlib, tqdm, and requests.Right now, users have to guess what Python packages to install. A simple
requirements.txtwould make installation (pip install -r requirements.txt) much easier.Continue breaking large files like
writer.pyinto smaller modules (services, helpers, etc.) for better maintainability.Happy to help with these in the future if you'd like!