DeepL.cr

Crystal library for the DeepL language translation API.

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     deepl:
       github: kojix2/deepl
   

2. Run shards install

Usage

require "deepl"

# Translate text
t = DeepL::Translator.new(auth_key: "YOUR_AUTH_KEY")
puts t.translate_text("こんにちは、世界！", target_lang: "EN") # => "Hello, world!"

# Translate document
t = DeepL::Translator.new(auth_key: "YOUR_AUTH_KEY")
puts t.translate_document("path/to/document.pdf", target_lang: "EN")
# Save to file (default: "path/to/document_EN.pdf")

# Rephrase text (improve writing)
t = DeepL::Translator.new(auth_key: "YOUR_AUTH_KEY")
result = t.rephrase_text("I have went to the store yesterday.")
puts result[0].text # => "I went to the store yesterday."

See documentation.

Environment Variables

• When the environment variable DEEPL_TARGET_LANG is set, the method DeepL::Translator#guess_target_language will prioritize the language defined in DEEPL_TARGET_LANG.
• However, please note that this does not directly affect translation methods like translate_text.

Development

• Pull requests are welcome.

• If you want to take over the project and become the owner, please submit your request with a pull request.

• DeepL OpenAPI Specification

Run tests (v2 / v3)

• v2 (default):

  crystal spec
  

• v3 (compile-time flag):

  crystal spec -Ddeepl_v3
  

• v3 (environment variable):

  DEEPL_API_VERSION=v3 crystal spec
  

Note: The library surface is also switched by the same conditions.

Use case

• DeepL CLI

Contributing

1. Fork it (https://github.com/kojix2/deepl.cr/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

License

MIT