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]

  Download all of Markdown posts and images.

Options:
  --target DIRECTORY  Target directory to save files.
  --in-tree           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-1.0.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

shodo-1.0.0-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for shodo-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ca524e43f22d7cb02e77aa8b82321ce76bee4f01b89b60f6ae3e36327c1a85f2
MD5 becf25a49194f0b399955cf6fe47bc15
BLAKE2b-256 fe8c293b89180b0a70fda0dd5e20ed2959010df94a7af1b9cee7bb9fa984affc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for shodo-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cca81abaf5df7e978ea6f8bf9dd160be079dbe728cb8dcf4e3959dfe422f76b8
MD5 0c7994103ac18f6304787d7e781caefa
BLAKE2b-256 546660d8af3558962b70d282962e9f1838efca2f3254af18dd767d891506113f

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