snewell/wlint

wlint
=====
|codacy|
|code-climate|

wlint is a collection of scripts and tools that can be used to help with
writing.  The project is designed for a Unix-like environment.


Dependencies
------------
wlint is designed for a Unix-like environment.  Any modern Linux distribution
should be fine, but OS X and Cygwin shouldn't have any problems either.

To ensure maximum portability, dependencies are kept to a minimum.  Currently
scripts are written in either :code:`/bin/sh` (assumes a typical collection of
standard command line tools) and Python 3 (assumed to be
:code:`/usr/bin/python3`).


Installing
----------
wlint installs using a :code:`setup.py` file.  The simplest installation
method just uses pip_.

.. code:: bash

    $ pip3 /path/to/wlint

If you don't have :code:`pip3` installed, it should be available in any
distribution's package manager.  If you can't or don't want to install
:code:`pip3`, you can also use :code:`python3` directly.

.. code:: bash

    $ python3 /path/to/wlint/setup.py install


Usage
-----
wlint follows the pattern of tools like :code:`git` and
:code:`apt-get`: there's a single front-end (:code:`wlint`) to launch other
tools.  To get a list of tools, use the :code:`--list` option.

Documentation for the other tools is available with the :code:`-h` or
:code:`--help` options, e.g.:

::

   wlint list-filter -h
   usage: list-filter [-h] [--file FILE] [--lists LISTS] [--list LIST]
                   [--sort-method SORT_METHOD]
                   [file [file ...]]


.. |codacy| image::
    https://api.codacy.com/project/badge/Grade/607e03f7700d4e1c958dc5c4d7bb588f
    :target: https://www.codacy.com/app/snewell/wlint?utm_source=github.com&utm_medium=referral&utm_content=snewell/wlint&utm_campaign=Badge_Grade

.. |code-climate| image::
    https://api.codeclimate.com/v1/badges/f2d5ee1555ff7ae6a0ff/maintainability
    :target: https://codeclimate.com/github/snewell/wlint/maintainability

.. _pip: https://pypi.python.org/pypi/pip