Skip to main content

An ArchChinese scraper for Anki

Project description

AnkiChinese

Asynchronousy scrape the ArchChinese dictionary to generate Anki flashcards with:

  • Pinyin & Audio
  • Definitions
  • Example words
  • Formation/Origin
  • Stroke order diagrams
  • HSK level

Installation

pip install ankichinese

Usage

ankichinese

-h, --help                  Show help message and exit 

-csv                        Output to CSV instead of Anki deck    
--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)

--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)

Generate New AnkiChinese Deck

How to create an entirely new Anki deck with the name ankichinese_output.apkg in the current directory using custom AnkiChinese styling.

  1. Create input.txt with the characters you want to scrape (avoid non-Chinese characters).
  2. Run ankichinese.
  3. Open Anki and import ankichinese_output.apkg.

Updating is Easy!
Just run ankichinese again with new characters in input.txt and import the new ankichinese_output.apkg file into Anki. Anki will automatically update the existing deck without losing progress.

Update Existing (Non-AnkiChinese) Deck Without Losing Progress

  1. Prepare current deck for export
    1. Decide what information you would like to add from the AnkiChinese deck.
    2. Create empty fields in your deck for the information you want to add.
  2. Export the deck you want to update from Anki using Notes in Plain Text (.txt) format. Check the Include unique identifier box.
  3. Open your deck in Excel or Google Sheets
    1. Excel
      1. Go to the Data -> From Text/CSV and import the exported deck file.
      2. Set File Origin to 65001: Unicode (UTF-8) and Delimiter to Tab and click Load.
    2. Google Sheets
      1. Go to File -> Import -> Upload and select the exported deck file.
      2. Set separator type to Tab and click Import data.
    3. Copy the entire column of Chinese characters into input.txt.
  4. Run ankichinese -csv
  5. Open your exported deck and the ankichinese_output.csv file in Excel or Google Sheets. (Use the same method as before)
  6. Sort both tables by the column containing Chinese characters.
  7. Copy your desired information from the ankichinese_output.csv table into your exported deck table. Do not add/delete columns or modify the GUID column of your deck.
  8. Save the file as a .csv file and import into Anki.

Tools Used

Credits

Stroke order diagrams:

Chinese audio:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

AnkiChinese-1.3.3.tar.gz (9.9 MB view hashes)

Uploaded Source

Built Distribution

AnkiChinese-1.3.3-py3-none-any.whl (7.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page