deepl

Elisp library for the DeepL API

The DeepL Elisp library provides convenient access to the DeepL API from applications written in the Elips language.

P.S. This package is expected to be used as a library, so there are only a few interactable commands you can use, and those are mostly examples.

📚 Documentation

• DeepL API docs

Table of Contents

• 🔨 Usage
  • 🔰 Example
• 🛑 Debugging
• 📂 Example projects
• 🔗 References
• Contribute

🔨 Usage

You will need to set up your API key before you can use this library.

(setq deepl-key "[YOUR API KEY]")

Alternatively, you can configure a function to retrieve the key from some external source. A function, deepl-key-auth-source is provided to retrieve the key from an auth-source entry under the :host key api.deepl.com

(setq deepl-key #deepl-key-auth-source)

For using another DEEPL endpoint,

(setq deepl-base-url "[DEEPL BASE URL]")

🔰 Example

Here is the simplest example that teaches you how to use this library. This is a function with a text, target-lang and a callback function.

(deepl-translate "How are you?" "ZH"  ; translate to Chinese
                 (lambda (data)
                   (message "%s" data)))

🛑 Debugging

While playing through this library, you might see this error quite often.

400 - Bad request.  Please check error message and your parameters

Try setting the variable deepl--show-log to t, it will show more error messages.

📂 Example projects

• N/A

🔗 References

• txl.el

Contribute

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!