Skip to main content

Shodo Python CLI

Project description

Shodo Python CLI

Installation

$ pip3 install shodo

Configuration

These environment variables are required

  • SHODO_API_ROOT Root endpoint for API (like https://api.shodo.ink/@my-organization/my-project/).
  • SHODO_API_TOKEN Token to access each projects (Access to Shodo and see projects' 「API連携」 settings page)

Usage

Lint Japanese. This command requires authentication (API root and a token) for Lint API projects (not for writing).

$ shodo lint filename.md
$ shodo lint ./demo/demo.md                                                                                          15:18:27
18:4 ら抜き言葉です
     てください。 すぐに食べれる(→ 食べられる)。 
...
3:11 もしかしてAI
     飛行機の欠便があり、運行(→ 運航)状況が変わった。 6:5 もしかしてAI
     ません。  これが私で(→ の)自己紹介です。  12:11 もしかしてAI
     なんでも問題を解決しい(→ トル)ます。 日本語ののよ

Download files

Download all of Markdown posts and images!

$ shodo download --target=docs

Options:

Usage: shodo download [OPTIONS]

Options:
  --target TEXT      Target directory to save files
  --in-tree BOOLEAN  Download only files with task Folder
  --help             Show this message and exit.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shodo-0.0.10.tar.gz (5.4 kB view hashes)

Uploaded Source

Built Distribution

shodo-0.0.10-py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page