README.md

grammarly

Grammarly API interface.

🔨 Examples

Below is an simple example that how you can use this library for calling Grammarly API interface.

(require 'grammarly)

(defun test-on-message (data)
  "On message callback with DATA."
  (message "[DATA] %s" data))

;; Set callback for receiving data.
(add-to-list 'grammarly-on-message-function-list 'test-on-message)

;; Send check text request.
(grammarly-check-text "Hello World")

💸 Using a Paid Grammarly Account

You will need the set the following variable in order to use paid version of Grammarly!

(setq grammarly-username "username@email.com")  ; Your Grammarly Username
(setq grammarly-password "password")  ; Your Grammarly Password

If you use auth-source to manage your secrets, you can add this to your .authinfo.gpg file:

machine grammarly.com login <your@email.com> pass <your-password>

And instead of directly setting grammarly-username and grammarly-password, you can call the helper function grammarly-load-from-authinfo.

(grammarly-load-from-authinfo)

;; Or, if you have multiple Grammarly accounts:
(grammarly-load-from-authinfo "your@email.com")

🔗 References

• grammarly-api
• reverse-engineered-grammarly-api
• grammarly (vscode)

📝 Todo List

• Support multiple requests at the same time.

🛠️ 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.