Metadata-Version: 2.1
Name: motto
Version: 0.1.1
Summary: Japanese sentence linter platform for reStructuredText
License: Apache-2.0
Author: Kazuya Takei
Author-email: attakei@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: click (>=7.0,<8.0)
Requires-Dist: click-default-group (>=1.2.2,<2.0.0)
Requires-Dist: dataclasses (>=0.7,<0.8); python_version >= "3.6" and python_version < "3.7"
Requires-Dist: docutils (>=0.15.2,<0.16.0)
Requires-Dist: janome (>=0.3.10,<0.4.0)
Requires-Dist: typing-extensions (>=3.7.4,<4.0.0)
Description-Content-Type: text/x-rst

motto
=====

.. image:: https://img.shields.io/pypi/v/motto
   :alt: PyPI
   :target: https://pypi.org/project/motto

.. image:: https://img.shields.io/pypi/pyversions/motto
   :alt: PyPI - Python Version
   :target: https://pypi.org/project/motto

.. image:: https://github.com/attakei/motto/workflows/Continuous%20Integration/badge.svg?branch=master
   :alt: GitHub Actions - Continuous Integration
   :target: https://github.com/attakei/motto/actions

docutils-based sentence linter.

Overview
--------

Motto is sentence linter platform for reStructuredText.

It parses document by ``docutils`` and check any paragraph by linter modules.

Demo
----

.. image:: https://attakei.net/assets/motto/motto-demo.gif

Installation
------------

You can install by ``pip`` command.

.. code-block:: bash

   pip install motto

Usage
-----

Run ``motto`` command.

.. code-block:: bash

   # Check single file
   motto README.rst
   # Checke internals of directory recursively
   motto docs/

More information
----------------

See `Janapanese readme document <./README_ja.rst>`_

License
-------

MIT License. See `it <./LICENSE>`_

