https://github.com/lucivpav/cwg
Chinese Worksheet Generator
https://github.com/lucivpav/cwg
chinese chinese-characters generator worksheet worksheets
Last synced: about 1 year ago
JSON representation
Chinese Worksheet Generator
- Host: GitHub
- URL: https://github.com/lucivpav/cwg
- Owner: lucivpav
- License: gpl-3.0
- Created: 2017-09-09T13:39:23.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-05-02T18:33:42.000Z (about 3 years ago)
- Last Synced: 2025-03-28T07:51:11.315Z (about 1 year ago)
- Topics: chinese, chinese-characters, generator, worksheet, worksheets
- Language: Python
- Homepage: http://chineseworksheetgenerator.org
- Size: 263 KB
- Stars: 80
- Watchers: 5
- Forks: 32
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Chinese Worksheet Generator
Allows one to generate Chinese practice worksheets.
[](https://travis-ci.org/lucivpav/cwg)
## Features
* Simplified and traditional Chinese
* Stroke order
* Radicals
* Words
* Customizable pinyin and translation
* Customizable title and grid style
## Dependencies
* [Make Me a Hanzi dataset](https://github.com/skishore/makemeahanzi)
* [CEDICT dataset](https://www.mdbg.net/chinese/dictionary?page=cedict)
* cairosvg
* reportlab
* flask
* [SourceHanSansTC-Normal.ttf](https://github.com/be5invis/source-han-sans-ttf/releases)
* [TagManager](https://maxfavilli.com/jquery-tag-manager)
## Installation notes
* Place TagManager folder into *frontend* folder
* [Windows 10 64-bit notes](https://github.com/lucivpav/cwg/wiki/Windows-10-64-bit-installation-notes)
## Words
* Use parentheses to group multiple characters together. This will add definition of such words into the sheet.
## Command line worksheet generation
### Show usage
```
gen.py
```
### Generate worksheet
```
gen.py --makemeahanzi=$MAKEMEAHANZI_PATH --cedict=$CEDICT_PATH --characters='你好' --title='Vocabulary' --guide='star' --stroke-order-color='red'
```
### Customize pinyin, translation and words
```
gen.py --makemeahanzi=$MAKEMEAHANZI_PATH --cedict=$CEDICT_PATH --characters='(你好)' --info # Generate character_infos.json
# You may edit the 'character_infos.json' and 'word_infos.json' to customize pinyin, translation and words
gen.py --makemeahanzi=$MAKEMEAHANZI_PATH --title='Vocabulary' --guide='star' --sheet # Generate worksheet
```
## Running tests
```
pipenv install
cd backend
pipenv run pytest test
```
## License
This project is released under the GPLv3 license, for more details, take a look at the LICENSE.txt file in the source code.