Metadata-Version: 2.1
Name: AnkiChinese
Version: 1.3.0
Summary: An ArchChinese scraper for Anki
Home-page: https://github.com/autoelk/AnkiChinese
Author: Luke Tao
Author-email: luketao68@gmail.com
Project-URL: Repository, https://github.com/autoelk/AnkiChinese
Project-URL: Bug Tracker, https://github.com/autoelk/AnkiChinese/issues
Project-URL: Changelog, https://github.com/autoelk/AnkiChinese/releases
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# AnkiChinese

Scrape the ArchChinese dictionary to generate Anki flashcards with:
1. Pinyin & Audio
2. Definitions
3. Common examples
4. Stroke order diagrams
5. HSK level

## 1. Installation

    pip install ankichinese

## 2. Usage

    ankichinese

    -h, --help                  Show help message and exit 

    --input, -i INPUT           Input file with characters to scrape (default: input.txt)
    --output, -o OUTPUT         Name of output file (do not include extension) 
                                (default: ankichinese_output)
    --type, -t {anki,csv}       Output file type (default: anki)

    --defs, -d NUM              Number of definitions to scrape per character (default: 5)
    --examples, -e NUM          Number of example words to scrape per character (default: 3)

## Credits
Online stroke order diagrams: https://hanziwriter.org/
Offline stroke order font: https://rtega.be/chmn/index.php?subpage=68

Chinese audio:
1. https://yoyochinese.com/chinese-learning-tools/Mandarin-Chinese-pronunciation-lesson/pinyin-chart-table
2. https://www.purpleculture.net/chinese_pinyin_chart/
MIT License

Copyright (c) 2023 Luke Tao

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
