README.md

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

• deepl
  • 📚 Documentation
  • 🔨 Usage
    • 🔰 Example
  • 🛑 Debugging
  • 📂 Example projects
  • 🔗 References
  • 🛠️ Contribute
    • 🔬 Development
  • ⚜️ License

🔨 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!

🔬 Development

To run the test locally, you will need the following tools:

• Eask
• Make (optional)

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.