Metadata-Version: 1.0
Name: gibi
Version: 0.1.1
Summary: Generate random words based on Markov chains
Home-page: https://github.com/Xowap/gibi
Author: Rémy Sanchez
Author-email: remy.sanchez@hyperthese.net
License: COPYING.txt
Description: Gibi
        ====
        
        Gibi is a random word generator, based on Markov chains.
        
        It analyzes a text in order to deduce the probability of transition from one
        character to another, and then generates a completely random word that will look
        alike what you have feeded it as input.
        
        Build status
        ------------
        
        .. |build-develop| image:: https://travis-ci.org/Xowap/gibi.png?branch=develop
        .. _build-develop: https://travis-ci.org/Xowap/gibi
        
        .. |build-master| image:: https://travis-ci.org/Xowap/gibi.png?branch=master
        .. _build-master: https://travis-ci.org/Xowap/gibi
        
        :develop: |build-develop|_
        :master: |build-master|_
        
        Usage
        -----
        
        Gibi can be used either as a CLI tool, either as a library.
        
        CLI
        ~~~
        
        The very simple `rand_word.py` will analyze any text file, and generate a random
        word based on it.
        
        .. code-block::
        
           $ rand_word.py french_cities.txt
           jambous-dirchetomeilla
        
        API
        ~~~
        
        The best way to see how to use the API is to look how `rand_word.py` works:
        
        .. code-block:: python
        
           with codecs.open(path, 'r', encoding='utf-8') as f:
               n = FrenchNormalizer(f)
               m = Matrix()
        
               m.feed(n)
        
           print(m.make_word())
        
        You can also make something deterministic by providing a seed to `make_word()`.
        Given the same `Matrix` and the same seed, you will always get the same result.
        The provided seed is anything that `Python's random <http://docs.python.org/3.3/library/random.html#random.seed>`_
        would accept. See the following example:
        
        .. code-block:: python
        
           assert m.make_word(42) == m.make_word(42)
        
        Legal terms
        -----------
        
        This project is written and copyrighted by its authors, as the Git log can
        testify.
        
        It is released under the terms of the WTFPL. Please refer to the COPYING file
        for more information.
        
Platform: UNKNOWN
