Metadata-Version: 1.1
Name: RandomWords
Version: 0.1.4
Summary: A useful module for a random text.
Home-page: https://github.com/tomislater/RandomWords
Author: Tomek Święcicki
Author-email: tomislater@gmail.com
License: LICENSE.txt
Description: RandomWords
        ===========
        
        Overview
        --------
        
        RandomWords is a useful package for generate random words, nicks and senteces (soon).
        
        Requirements
        ------------
        
        * Python 2.6 or 2.7
        * Liunx, Windows?, Mac OSX?, BSD?
        
        Install
        -------
        
        Quick way::
        
            pip install RandomWords
        
        or::
        
            git clone https://github.com/tomislater/RandomWords.git
            cd RandomWords
            python setup.py install
        
        How to use
        ----------
        
        *Random words*::
        
            >>> from random_words import RandomWords
            >>> rw = RandomWords()
            >>> word = rw.random_word()
            >>> print word
            factors
        
            >>> word = rw.random_word('y')
            >>> print word
            yards
        
            >>> words = rw.random_words(count=10)
            >>> print words
            ['runs', 'experience', 'comments', 'freedom', 'permit', 'honks', 'pins', 'texts', 'grant', 'fathers']
        
            >>> words = rw.random_words(letter='r', count=5)
            >>> print words
            ['raincoat', 'reactance', 'room', 'relocation', 'rudders']
        
            >>> words = rw.random_words(letter=None, count=2)
            >>> print words
            ['tides', 'eights']
        
        *Random nicks*::
        
            >>> from random_words import RandomNicknames
            >>> rn = RandomNicknames()
            
            >>> rn.random_nick()
            'Fredrick'
            
            >>> rn.random_nick('y')
            'York'
            
            >>> rn.random_nick(letter='r', gender='m')
            'Roosevelt'
            
            >>> rn.random_nick(letter='r', gender='f')
            'Rene'
            
            >>> rn.random_nicks()
            ['Fionn']
            
            >>> rn.random_nicks(count=10)
            ['Kristy', 'Imani', 'Delbert', 'Brevyn', 'Jasmin', 'Genevieve', 'Clodagh', 'Graham', 'Sondra', 'Ed']
            
            >>> rn.random_nicks(letter='u', gender='f', count=4)
            ['Una', 'Uma', 'Ursula', 'Ulrica']
        
            >>> rn.random_nicks(letter='a', gender='m', count=4)
            ['Anthony', 'Alec', 'Antonio', 'Adam']
            
            >>> rn.random_nicks(gender='m', count=5)
            ['Elijah', 'Abraham', 'Noel', 'Myles', 'Pedro']
        
            >>> rn.random_nicks(gender='f', count=5)
            ['Sabrina', 'Debbie', 'Jerri', 'Savannah', 'Wendy']
        
        *Lorem ipsum*::
        
            >>> from random_words import LoremIpsum
            >>> li = LoremIpsum()
            >>> li.get_sentence()
            'Commodo gubergren fringilla curabitur quam volutpatut.'
            
            >>> li.get_sentence(max_words=22)  # random sample from 3 to 22 ;)
            'Voluptua curae; facilisi mi auctormauris neque enim aliquam stet odio sedfusce porttitor magnis ultrices.'
        
            >>> li.get_sentences(max_words=5, sentences=3)
            'Tortor mazim nobis ex. Luptatum assum rhoncus labore. Nequeetiam montes nibh.'
            
            >>> li.get_sentences_list(max_words=13, sentences=5)
            ['Torquent per duo aaenean accumsannulla magnapraesent sollicitudin eirmod duis lobortisetiam minim metusdonec.', 'Possim egestasmauris accumsannulla netus cubilia suspendisse qui facer enimsed nonummy.', 'Congue faucibusvestibulum conubia lectus laoreet dignissim tortorcurabitur natoque voluptua penatibus facilisinam.', 'Ante semper sociis leo.', 'Dignissim arcu sea metus sed ultriciespellentesque malesuadanullam wisi nullamauris.']
        
        TODO
        ----
        
        * random sentence/sentences
        * random lorem ipsum
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
