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.11.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

shodo-0.0.11-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file shodo-0.0.11.tar.gz.

File metadata

  • Download URL: shodo-0.0.11.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for shodo-0.0.11.tar.gz
Algorithm Hash digest
SHA256 70589d70e5f7370eda2524669f45e151e2fa3dbac0ba9393722153a93e9c796c
MD5 eceab623ffc283e5aa077fcd24e18fae
BLAKE2b-256 971f89cbb6e2aa1502b880d49087ef0fa799102d6ffe217b3107d50b69b42eb3

See more details on using hashes here.

File details

Details for the file shodo-0.0.11-py3-none-any.whl.

File metadata

  • Download URL: shodo-0.0.11-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for shodo-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 6a7094ce4e105d165398569824ce894140f71a9d5fbe48846f32ac21e5184385
MD5 cb08af7c8febb6128d2252fea99840a3
BLAKE2b-256 13d9d1ebf888e39539c21b67eade792df406251327b7e41046d4f291a978127a

See more details on using hashes here.

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