Metadata-Version: 1.1
Name: crosswords
Version: 0.3.1
Summary: Crosswords help in your terminal
Home-page: https://github.com/bfontaine/crosswords
Author: Baptiste Fontaine
Author-email: b@ptistefontaine.fr
License: Copyright © 2014 – Baptiste Fontaine

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Description: ==========
        crosswords
        ==========
        
        .. image:: https://img.shields.io/travis/bfontaine/crosswords.png
           :target: https://travis-ci.org/bfontaine/crosswords
           :alt: Build status
        
        .. image:: https://img.shields.io/coveralls/bfontaine/crosswords/master.png
           :target: https://coveralls.io/r/bfontaine/crosswords?branch=master
           :alt: Coverage status
        
        .. image:: https://img.shields.io/pypi/v/crosswords.png
           :target: https://pypi.python.org/pypi/crosswords
           :alt: Pypi package
        
        .. image:: https://img.shields.io/pypi/dm/crosswords.png
           :target: https://pypi.python.org/pypi/crosswords
        
        **crosswords** is a terminal tool to help you solving crosswords.
        
        This is a full rewrite of a script I wrote back in 2011.
        
        Install
        -------
        
        .. code-block::
        
            pip install crosswords
        
        To upgrade a previous installation, use:
        
        .. code-block::
        
            pip install -U crosswords
        
        Usage
        -----
        
        .. code-block::
        
            crosswords [-l <language>] <word>
        
        Your word should have ``?`` characters for each letter you don't know, e.g.:
        ``bon??ur``. By default, the tool returns up to 8 possible words.
        
        Some words have special meaning:
        
        - ``list``: list local languages
        - ``remote_list``: list remote languages
        - ``install``: install a language
        - ``update``: update local languages
        
        A language dictionnary is a file with one word per line, without accents,
        hyphens or special chars. Local dictionnaries are stored in
        ``~/.crosswords/dicts``. Remote ones are on my website.
        
        Languages
        ~~~~~~~~~
        
        Here are the currently available languages. You can install any of them with
        ``crosswords install <language>``.
        
        - English (``english``):  `70k words`_
        - French (``french``): 300k words
        
        .. _70k words : http://www-personal.umich.edu/~jlawler/wordlist.html
        
        Tests
        -----
        
        Clone this repo, then: ::
        
            [sudo] make deps
            make check
        
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
