Skip to content

Commit 3e39c22

Browse files
IMPORTANT for SUBMISSION: python-frontmatter README update
NOT IN ASSESSMENT SUBMISSION. Adds a clause within the Warnings and Prerequisites section detailing how to fix a common package conflict with frontmatter. [skip render]
1 parent 55531cd commit 3e39c22

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,31 @@ Lingual HSC is a Flask-based language learning web application built for HSC stu
6969
- If you want to use the WaniKani API features for kanji details, you will need a valid `WANIKANI_API_KEY` in your `.env`. The app includes cached data for the 201 prescribed kanji, so the API key is only necessary if you want to fetch details for non-prescribed kanji or refresh cached data.
7070
- After setting up the database, you may want to create a test user account by registering through the app's registration page. This will allow you to explore authenticated features and progress tracking.
7171

72-
You are now ready to explore the features of Lingual HSC!
72+
### **IMPORTANT**: frontmatter
73+
It is likely you'll encounter the following error when attempting to run this project:
74+
```shell
75+
WARNING in lesson_processor: An unknown error occured while fetching 'verb-groups' in category 'senior-structures': module 'frontmatter' has no attribute 'load'
76+
WARNING in lesson_processor: An unknown error occured while fetching 'te-form' in category 'senior-structures': module 'frontmatter' has no attribute 'load'
77+
WARNING in lesson_processor: An unknown error occured while fetching 'plain-form' in category 'senior-structures': module 'frontmatter' has no attribute 'load'
78+
WARNING in lesson_processor: An unknown error occured while fetching 'particle-he' in category 'senior-structures': module 'frontmatter' has no attribute 'load'
79+
80+
// And so forth
81+
```
82+
83+
This error exists due to the package `frontmatter` likely already being installed on your machine, forcing itself into the virtual environment. To resolve this error:
84+
85+
- Within the virtual environment, run the following command.
86+
```shell
87+
pip uninstall frontmatter python-frontmatter
88+
```
89+
This removes any instance of frontmatter in the environment you are currently using.
90+
- Reinstall **python-frontmatter**
91+
```shell
92+
pip install python-frontmatter
93+
```
94+
- Start the server.
95+
96+
Now, you should be ready to explore the features of Lingual HSC!
7397
7498
# Main Features
7599

0 commit comments

Comments
 (0)