ChinesePhrases

Converts a csv of Chinese words to a csv of example sentences for use in Anki.

Note: This uses the free online dictionary at dict.naver.com to pull sentences, please be respectful.

Context

As you're learning Chinese you'll come across new words that you would like to practice. You can use this gem as such:

  • As you read an article or watch a video
  • Write down any new words you find on a new in line a text file
  • Enter only one word per line
  • Once done, save the file
  • Use this library to convert those words into examples sentences
  • These sentences can be used for your own study in Anki or whatever you like

Installation

Add this line to your application's Gemfile:

gem 'chinese_phrases'

And then execute:

$ bundle

Or install it yourself as:

$ gem install chinese_phrases

Usage

chinese_phrases export input_words.csv

Output will be at output_phrases.csv.

By default output will be in traditional Chinese.

chinese_phrases help export

Usage:
  chinese_phrases export

Options:
  [--output-file=OUTPUT_FILE]
  [--max-len=N]
                               # Default: 15
  [--max-per=N]
                               # Default: 10
  [--page-size=N]
                               # Default: 50
  [--trad], [--no-trad]
                               # Default: true

Output given word csv to phrases csv

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bendangelo/chinese_phrases. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the ChinesePhrases project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.