kojix2 / deepl.cr

Crystal library for the DeepL language translation API.

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

See documentation.

Environment Variables

Name	Description
DEEPL_AUTH_KEY	DeepL API authentication key
DEEPL_TARGET_LANG	Default target language
DEEPL_USER_AGENT	User-Agent

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.

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